Interface CustomDataCategoryObjects

Represents custom data category objects with methods for managing custom data categories.

interface CustomDataCategoryObjects {
    Delete: ((categoryOrId: number | CustomDataCategoryObject, itemKey: string, callback: ((success: boolean) => void)) => void);
    Get: ((categoryOrId: number | CustomDataCategoryObject, page: number, pageSize: number, callback: ((obj: {
        [key: string]: object | any;
    }) => void)) => void);
    GetCategories: ((optionalNamePattern: string, callback: ((data: []) => void)) => void);
    Refresh: ((categoryOrId: number | CustomDataCategoryObject) => void);
    Save: ((categoryOrId: number | CustomDataCategoryObject, itemKey: string, obj: any, callback: ((success: boolean) => void)) => void);
    Search: ((categoryOrId: number | CustomDataCategoryObject, key: string, value: string, page: number, pageSize: number, exactMatch: boolean, callback: ((data: []) => void)) => void);
    SearchPaged: ((filter: CustomDataSearchObject, callback: ((data: PagedList<KeyValue<string, object>>) => void)) => void);
}

Properties

Delete Get GetCategories Refresh Save Search SearchPaged

Properties

Delete

Delete: ((categoryOrId: number | CustomDataCategoryObject, itemKey: string, callback: ((success: boolean) => void)) => void)

Deletes a custom data item from a category.

Type declaration

    • (categoryOrId, itemKey, callback): void

    • Parameters

      • categoryOrId: number | CustomDataCategoryObject

        Category ID or custom data category object.

      • itemKey: string

        Key of the item to delete.

      • callback: ((success: boolean) => void)

        Callback function that receives a boolean indicating success.

          • (success): void

          • Parameters

            • success: boolean

            Returns void

      Returns void

Get

Get: ((categoryOrId: number | CustomDataCategoryObject, page: number, pageSize: number, callback: ((obj: {
    [key: string]: object | any;
}) => void)) => void)

Retrieves custom data objects by category or ID, paginated.

Type declaration

    • (categoryOrId, page, pageSize, callback): void

    • Parameters

      • categoryOrId: number | CustomDataCategoryObject

        Category ID or custom data category object.

      • page: number

        Page number for pagination.

      • pageSize: number

        Number of items per page.

      • callback: ((obj: {
            [key: string]: object | any;
        }) => void)

        Callback function that receives the object data.

          • (obj): void

          • Parameters

            • obj: {
                  [key: string]: object | any;
              }
              • [key: string]: object | any

            Returns void

      Returns void

GetCategories

GetCategories: ((optionalNamePattern: string, callback: ((data: []) => void)) => void)

Retrieves categories optionally filtered by name pattern.

Type declaration

    • (optionalNamePattern, callback): void

    • Parameters

      • optionalNamePattern: string

        Optional pattern to filter category names.

      • callback: ((data: []) => void)

        Callback function that receives the data array.

          • (data): void

          • Parameters

            • data: []

            Returns void

      Returns void

Refresh

Refresh: ((categoryOrId: number | CustomDataCategoryObject) => void)

Refreshes data in a custom data category.

Type declaration

    • (categoryOrId): void

    • Parameters

      Returns void

Save

Save: ((categoryOrId: number | CustomDataCategoryObject, itemKey: string, obj: any, callback: ((success: boolean) => void)) => void)

Saves a custom data item to a category.

Type declaration

    • (categoryOrId, itemKey, obj, callback): void

    • Parameters

      • categoryOrId: number | CustomDataCategoryObject

        Category ID or custom data category object.

      • itemKey: string

        Key of the item to save.

      • obj: any

        Data object to save.

      • callback: ((success: boolean) => void)

        Callback function that receives a boolean indicating success.

          • (success): void

          • Parameters

            • success: boolean

            Returns void

      Returns void

Search

Search: ((categoryOrId: number | CustomDataCategoryObject, key: string, value: string, page: number, pageSize: number, exactMatch: boolean, callback: ((data: []) => void)) => void)

Searches for custom data items within a category.

Type declaration

    • (categoryOrId, key, value, page, pageSize, exactMatch, callback): void

    • Parameters

      • categoryOrId: number | CustomDataCategoryObject

        Category ID or custom data category object.

      • key: string

        Key to search within items.

      • value: string

        Value to search for.

      • page: number

        Page number for pagination.

      • pageSize: number

        Number of items per page.

      • exactMatch: boolean

        Indicates whether to perform an exact match search.

      • callback: ((data: []) => void)

        Callback function that receives the search results array.

          • (data): void

          • Parameters

            • data: []

            Returns void

      Returns void

SearchPaged

SearchPaged: ((filter: CustomDataSearchObject, callback: ((data: PagedList<KeyValue<string, object>>) => void)) => void)

Searches for custom data items using pagination and filtering criteria.

Type declaration

    • (filter, callback): void

    • Parameters

      Returns void

Settings

Member Visibility

On This Page

Properties