Interface DominoSetupRestSession

Interface to perform SETUP Rest API operations.

interface DominoSetupRestSession {
    createUpdateListView: (
        dataSource: string,
        listView: ListViewBody,
        designName: string,
        options?: DesignOptions,
    ) => Promise<CreateUpdateListResponse>;
    createUpdateScope: (
        scope: ScopeJSON | DominoRestScope,
    ) => Promise<DominoScope>;
    deleteScope: (scopeName: string) => Promise<DominoScope>;
    dominoAccess: DominoRestAccess;
    dominoConnector: DominoRestConnector;
    getListView: (
        dataSource: string,
        designName: string,
        options?: DesignOptions,
    ) => Promise<GetListViewDesignJSON>;
    getScope: (scopeName: string) => Promise<DominoScope>;
    getScopes: () => Promise<DominoScope[]>;
}

Implemented by

Properties

createUpdateListView createUpdateScope deleteScope dominoAccess dominoConnector getListView getScope getScopes

Properties

createUpdateListView

createUpdateListView: (
    dataSource: string,
    listView: ListViewBody,
    designName: string,
    options?: DesignOptions,
) => Promise<CreateUpdateListResponse>

Create or update Domino design view based on simplified JSON.

Type declaration

Throws

an error if given scope name is empty.

Throws

an error if given design name is empty.

createUpdateScope

createUpdateScope: (scope: ScopeJSON | DominoRestScope) => Promise<DominoScope>

Create a scope on the server, otherwise, update it if it already exists.

Type declaration

deleteScope

deleteScope: (scopeName: string) => Promise<DominoScope>

Delete a scope on the server.

Type declaration

    • (scopeName: string): Promise<DominoScope>

    • Parameters

      • scopeName: string

        the name of scope to be deleted

      Returns Promise<DominoScope>

      A promise that resolves to the deleted scope.

Throws

an error if given scope name is empty.

dominoAccess

dominoAccess: DominoRestAccess

Provides access to Domino REST API server.

dominoConnector

dominoConnector: DominoRestConnector

Provides accessible operations and its required parameters.

getListView

getListView: (
    dataSource: string,
    designName: string,
    options?: DesignOptions,
) => Promise<GetListViewDesignJSON>

Retrieve individual design element (view) for a database.

Type declaration

Throws

an error if given scope name is empty.

Throws

an error if given design name is empty.

getScope

getScope: (scopeName: string) => Promise<DominoScope>

Retrieves rest configuration from the server.

Type declaration

    • (scopeName: string): Promise<DominoScope>

    • Parameters

      • scopeName: string

        the name of scope to be retrieved

      Returns Promise<DominoScope>

      a promise that resolves to the fetched scope.

Throws

an error if given scope name is empty.

getScopes

getScopes: () => Promise<DominoScope[]>

Get all of the scopes on the server.

Type declaration

    • (): Promise<DominoScope[]>

    • Returns Promise<DominoScope[]>

      a promise that resolves to an array of domino scopes.

Settings

Member Visibility

On This Page

Properties