Class DominoSetupSession

constructor

• new DominoSetupSession(
      dominoAccess: DominoRestAccess,
      dominoConnector: DominoRestConnector,
  ): DominoSetupSession

  Parameters

  • dominoAccess: DominoRestAccess
  • dominoConnector: DominoRestConnector

  Returns DominoSetupSession

dominoAccess

dominoConnector

createUpdateListView

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

  Parameters

  • dataSource: string

    the scope name
  • listView: ListViewBody

    a type ListViewBody JSON that is the format when creating a design element view.
  • designName: string

    name of design element
  • Optionaloptions: DesignOptions

    parameters that we want to use for the endpoint PUT /design/views/{designName} in a specific format

  Returns Promise<CreateUpdateListResponse>

  A promise that resolves to a type of CreateUpdateListResponse.

createUpdateScope

• createUpdateScope(scope: ScopeBody | DominoRestScope): Promise<DominoScope>

  Parameters

  • scope: ScopeBody | DominoRestScope

    accepts a DominoScope or a JSON format containing all of the fields needed when creating a Domino REST scope

  Returns Promise<DominoScope>

  a promise that resolves to the created scope.

deleteScope

• deleteScope(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.

getListView

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

  Parameters

  • dataSource: string

    the scope name
  • designName: string

    name of design element
  • Optionaloptions: DesignOptions

    parameters that we want to use for the endpoint GET /design/views/{designName} in a specific format

  Returns Promise<GetListViewDesignJSON>

  A promise that resolves to a type GetListViewDesignJSON.

getScope

• getScope(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.

getScopes

• getScopes(): Promise<DominoScope[]>

  Returns Promise<DominoScope[]>

  a promise that resolves to an array of domino scopes.

Static ReadonlygetSetupSession

• getSetupSession(
      dominoAccess: DominoRestAccess,
      dominoServer: DominoRestServer,
  ): Promise<DominoSetupSession>

  Static factory method to get DominoSetupSession.

  Parameters

  • dominoAccess: DominoRestAccess

    DominoAccess to use
  • dominoServer: DominoRestServer

    DominoServer to use

  Returns Promise<DominoSetupSession>

  DominoSetupSession class