Type Alias ObjectHelperFunctions

type ObjectHelperFunctions = {
    getListData<ItemType>(listDef: ListBoxProperties): Promise<ItemType[]>;
    getListObject<ItemType>(
        listDef: ListBoxProperties,
    ): Promise<GenericListObject<ItemType>>;
    getOrCreateSessionObject<
        GenericObjectCustomType extends
            GenericObject<AnyGenericObjectProperties, AnyGenericObjectLayout> = GenericObject<
            AnyGenericObjectProperties,
            AnyGenericObjectLayout,
        >,
    >(
        props: ListBoxProperties,
    ): Promise<GenericObjectCustomType>;
}

Index

Methods

getListData getListObject getOrCreateSessionObject

Methods

getListData

getListData<ItemType>(listDef: ListBoxProperties): Promise<ItemType[]>
Help method to fetch app object data from Engine through a session object
Type Parameters
- ItemType
Parameters
- listDef: ListBoxProperties
  specifications of which type of list to fetch
  - OptionalqAppObjectListDef?: AppObjectListDef
  - OptionalqInfo?: NxInfo
  - OptionalqListBoxDef?: ListObjectDef
Returns Promise<ItemType[]>
A Promise that when resolved holds a list of data objects of the specified type

getListObject

getListObject<ItemType>(
listDef: ListBoxProperties,
): Promise<GenericListObject<ItemType>>
Help method to fetch list objects from Engine through as session objects
Type Parameters
- ItemType
Parameters
- listDef: ListBoxProperties
  specifications of which type of list to fetch
  - OptionalqAppObjectListDef?: AppObjectListDef
  - OptionalqInfo?: NxInfo
  - OptionalqListBoxDef?: ListObjectDef
Returns Promise<GenericListObject<ItemType>>
Promise containing the list handling object if resolved or Error if rejected

getOrCreateSessionObject

getOrCreateSessionObject<
    GenericObjectCustomType extends
        GenericObject<AnyGenericObjectProperties, AnyGenericObjectLayout> = GenericObject<
        AnyGenericObjectProperties,
        AnyGenericObjectLayout,
    >,
>(
    props: ListBoxProperties,
): Promise<GenericObjectCustomType>
Type Parameters
- GenericObjectCustomType extends GenericObject<AnyGenericObjectProperties, AnyGenericObjectLayout> = GenericObject<AnyGenericObjectProperties, AnyGenericObjectLayout>
Parameters
- props: ListBoxProperties
Returns Promise<GenericObjectCustomType>