Class UpdateOwnerHandler

Responsible for adding/updating/deleting owners in pods.

Hierarchy (view full)

JsonInteractionHandler
- UpdateOwnerHandler

Implements

JsonView

Index

Constructors

Methods

canHandle findVerifiedPod getView handle handleSafe

Constructors

constructor

new UpdateOwnerHandler(podStore, podRoute): UpdateOwnerHandler
Parameters
- podStore: PodStore
- podRoute: PodIdRoute
Returns UpdateOwnerHandler
Overrides JsonInteractionHandler.constructor
- Defined in src/identity/interaction/pod/UpdateOwnerHandler.ts:27

Methods

canHandle

canHandle(input): Promise<void>
Checks whether the input can be handled by this class. If it cannot handle the input, rejects with an error explaining why.
Parameters
- input: JsonInteractionHandlerInput
  Input that could potentially be handled.
Returns Promise<void>
A promise resolving if the input can be handled, rejecting with an Error if not.
Inherited from JsonInteractionHandler.canHandle
- Defined in src/util/handlers/AsyncHandler.ts:18

`Protected`findVerifiedPod

findVerifiedPod(target, accountId?): Promise<{
    accountId: string;
    baseUrl: string;
    id: string;
}>
Extract the pod ID from the path and find the associated pod. Asserts that the given account ID is the creator of this pod.
Parameters
- target: ResourceIdentifier
- OptionalaccountId: string
Returns Promise<{
    accountId: string;
    baseUrl: string;
    id: string;
}>
- Defined in src/identity/interaction/pod/UpdateOwnerHandler.ts:59

getView

getView(__namedParameters): Promise<JsonRepresentation<Dict<Json>>>
Parameters
- __namedParameters: JsonInteractionHandlerInput
Returns Promise<JsonRepresentation<Dict<Json>>>
Implementation of JsonView.getView
- Defined in src/identity/interaction/pod/UpdateOwnerHandler.ts:33

handle

handle(input): Promise<JsonRepresentation<EmptyObject>>
Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.
Parameters
- input: JsonInteractionHandlerInput
  Input that needs to be handled.
Returns Promise<JsonRepresentation<EmptyObject>>
A promise resolving when handling is finished.
Overrides JsonInteractionHandler.handle
- Defined in src/identity/interaction/pod/UpdateOwnerHandler.ts:40

handleSafe

handleSafe(input): Promise<JsonRepresentation<Dict<Json>>>
Helper function that first runs canHandle followed by handle. Throws the error of canHandle if the data cannot be handled, or returns the result of handle otherwise.
Parameters
- input: JsonInteractionHandlerInput
  Input data that will be handled if it can be handled.
Returns Promise<JsonRepresentation<Dict<Json>>>
A promise resolving if the input can be handled, rejecting with an Error if not.
Inherited from JsonInteractionHandler.handleSafe
- Defined in src/util/handlers/AsyncHandler.ts:41