Interface HandlesModule

Management of this client's owned handles in the Secure Communications Service.

interface HandlesModule {
    deprovisionHandle(handleId: HandleId): Promise<void>;
    listHandles(input: ListHandlesInput): Promise<ListOutput<OwnedHandle>>;
    provisionHandle(input: ProvisionHandleInput): Promise<OwnedHandle>;
    updateHandle(input: UpdateHandleInput): Promise<OwnedHandle>;
}

Implemented by

DefaultHandlesModule

Index

Methods

deprovisionHandle listHandles provisionHandle updateHandle

Methods

deprovisionHandle

deprovisionHandle(handleId: HandleId): Promise<void>
Deletes an existing handle owned by this client.
Parameters
- handleId: HandleId
  The identifier associated with the handle to deprovision.
Returns Promise<void>
- Defined in src/public/modules/handlesModule.ts:72

listHandles

listHandles(input: ListHandlesInput): Promise<ListOutput<OwnedHandle>>
List all handles owned by this client.
Parameters
- input: ListHandlesInput
Returns Promise<ListOutput<OwnedHandle>>
A list of all handles matching the search criteria.
- Defined in src/public/modules/handlesModule.ts:87

provisionHandle

provisionHandle(input: ProvisionHandleInput): Promise<OwnedHandle>
Provisions a new handle.
Parameters
- input: ProvisionHandleInput
  Parameters used to provision a handle.
Returns Promise<OwnedHandle>
A new handle.
- Defined in src/public/modules/handlesModule.ts:65

updateHandle

updateHandle(input: UpdateHandleInput): Promise<OwnedHandle>
Updates an existing handle owned by this client.
Parameters
- input: UpdateHandleInput
  Parameters used to update the handle.
Returns Promise<OwnedHandle>
The updated handle.
- Defined in src/public/modules/handlesModule.ts:80