Interface UiConfigAPI

interface UiConfigAPI {
    clearCache: () => void;
    createUiConfigPinnedLink: (
        body: CreatePinnedLinkPayload & CreatePinnedLinkConfigPayload,
        options?: ApiCallOptions,
    ) => Promise<CreateUiConfigPinnedLinkHttpResponse>;
    createUiConfigPinnedLinks: (
        body: BulkCreatePinnedLinkItemPayload,
        options?: ApiCallOptions,
    ) => Promise<CreateUiConfigPinnedLinksHttpResponse>;
    deleteAllUiConfigPinnedLinks: (
        options?: ApiCallOptions,
    ) => Promise<DeleteAllUiConfigPinnedLinksHttpResponse>;
    deleteUiConfigPinnedLink: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteUiConfigPinnedLinkHttpResponse>;
    getUiConfigPinnedLink: (
        id: string,
        options?: ApiCallOptions,
    ) => Promise<GetUiConfigPinnedLinkHttpResponse>;
    getUiConfigPinnedLinks: (
        options?: ApiCallOptions,
    ) => Promise<GetUiConfigPinnedLinksHttpResponse>;
    patchUiConfigPinnedLink: (
        id: string,
        body: JSONPatchPinnedLinkPayload,
        options?: ApiCallOptions,
    ) => Promise<PatchUiConfigPinnedLinkHttpResponse>;
}
Index

Properties

clearCache createUiConfigPinnedLink createUiConfigPinnedLinks deleteAllUiConfigPinnedLinks deleteUiConfigPinnedLink getUiConfigPinnedLink getUiConfigPinnedLinks patchUiConfigPinnedLink

Properties

clearCache: () => void

Clears the cache for ui-config api requests.

Type Declaration

    • (): void

    • Clears the cache for ui-config api requests.

      Returns void

createUiConfigPinnedLink: (
    body: CreatePinnedLinkPayload & CreatePinnedLinkConfigPayload,
    options?: ApiCallOptions,
) => Promise<CreateUiConfigPinnedLinkHttpResponse>

Creates a pinned link, which will appear below any existing pinned links in the tenant. Requires calling user to be assigned the TenantAdmin role. A tenant can have a maximum of 50 pinned links.

Type Declaration

Param: body

an object with the body content

CreateUiConfigPinnedLinkHttpError

createUiConfigPinnedLinks: (
    body: BulkCreatePinnedLinkItemPayload,
    options?: ApiCallOptions,
) => Promise<CreateUiConfigPinnedLinksHttpResponse>

Creates one or more pinned links for navigation, an alternative method to multiple calls to /ui-config/pinned-links. Links are displayed below any existing pinned links, and will be added in the order sent in the request. Requires calling user to be assigned the TenantAdmin role. A tenant can have a maximum of 50 pinned links.

Type Declaration

Param: body

an object with the body content

CreateUiConfigPinnedLinksHttpError

deleteAllUiConfigPinnedLinks: (
    options?: ApiCallOptions,
) => Promise<DeleteAllUiConfigPinnedLinksHttpResponse>

Deletes all pinned links in the tenant. Requires calling user to be assigned the TenantAdmin role.

Type Declaration

DeleteAllUiConfigPinnedLinksHttpError

deleteUiConfigPinnedLink: (
    id: string,
    options?: ApiCallOptions,
) => Promise<DeleteUiConfigPinnedLinkHttpResponse>

Deletes a specific pinned link. Requires calling user to be assigned the TenantAdmin role.

Type Declaration

The pinned link identifier.

DeleteUiConfigPinnedLinkHttpError

getUiConfigPinnedLink: (
    id: string,
    options?: ApiCallOptions,
) => Promise<GetUiConfigPinnedLinkHttpResponse>

Retrieves a specific pinned link.

Type Declaration

The pinned link identifier.

GetUiConfigPinnedLinkHttpError

getUiConfigPinnedLinks: (
    options?: ApiCallOptions,
) => Promise<GetUiConfigPinnedLinksHttpResponse>

Retrieves a list of all pinned links. All users can list pinned links. This endpoint does not support pagination as a tenant can have a maximum of 50 pinned links at one time.

Type Declaration

GetUiConfigPinnedLinksHttpError

patchUiConfigPinnedLink: (
    id: string,
    body: JSONPatchPinnedLinkPayload,
    options?: ApiCallOptions,
) => Promise<PatchUiConfigPinnedLinkHttpResponse>

Updates a specific pinned link with an array of JSON patches. Requires calling user to be assigned the TenantAdmin role.

Type Declaration

The pinned link identifier.

Param: body

an object with the body content

PatchUiConfigPinnedLinkHttpError

Settings

Member Visibility

On This Page

Properties