Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SessionTrees

Hierarchy

  • SessionTrees

Index

Methods

getBranchMappingTable

  • Parameters

    • sessionTreeBranch: string

    Returns Result<BranchMappingTable>

    a Result that resolves when a response is received from the server, returning the branch mapping table for sessionTreeBranch.

    If the task fails, the Result will be rejected with an error. Common reasons for failure include:

    • the calling session does not have the READ_TOPIC permission for sessionTreeBranch;
    • the session is closed.
    • NullValueError – if sessionTreeBranch null or undefined

getSessionTreeBranchesWithMappings

  • getSessionTreeBranchesWithMappings(): Result<string[]>
  • Returns Result<string[]>

    a Result that resolves when a response is received from the server, returning a list of session tree branches in path order.

    If the task fails, the the Result will be rejected with an error. Common reasons for failure include:

    • the session is closed.

putBranchMappingTable

  • Parameters

    Returns Result<any>

    a Result that resolves when a response is received from the server.

    If the task completes successfully, the CompletableFuture result will be null. The result type is any rather than void to provide forward compatibility with future iterations of this API that may provide a non-null result with a more specific result type.

    Otherwise, the Result will be rejected with an error. Common reasons for failure include:

    • the branchMappingTable or one of its branch mappings is invalid;
    • the calling session does not have the MODIFY_TOPIC permission for the session tree branch of the branch mapping table, EXPOSE_BRANCH permission for each branch mapping of branchMappingTable, and (if there is an existing table for the session tree branch) EXPOSE_BRANCH permission for each branch mapping of existing table;
    • the operation failed due to a transient cluster error;
    • the session is closed.
    • NullValueError – if branchMappingTable is null or undefined