ConnectClient Class
Beta
Client API to access the connect services.
Extends
Methods
Inherited methods
Name |
Inherited from |
Description |
delete(requestContext: AuthorizedClientRequestContext, relativeUrlPath: string): Promise<void> Protected |
Client |
used by clients to send delete requests |
deleteInstance<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, relativeUrlPath: string, instance?: T, requestOptions?: WsgRequestOptions): Promise<void> Protected |
WsgClient |
used by clients to delete strongly typed instances through the standard WSG REST API |
getInstances<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, typedConstructor: object, relativeUrlPath: string, queryOptions?: RequestQueryOptions): Promise<T extends WsgInstance[]> Protected |
WsgClient |
Used by clients to get strongly typed instances from standard WSG REST queries that return EC JSON instances. |
getUrl(requestContext: ClientRequestContext, excludeApiVersion?: false | true): Promise<string> |
WsgClient |
Gets the URL of the service. |
postInstance<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, typedConstructor: object, relativeUrlPath: string, instance: T extends WsgInstance, requestOptions?: WsgRequestOptions): Promise<T extends WsgInstance> Protected |
WsgClient |
Used by clients to post strongly typed instances through standard WSG REST API |
postInstances<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, typedConstructor: object, relativeUrlPath: string, instances: T extends WsgInstance[], requestOptions?: WsgRequestOptions): Promise<T extends WsgInstance[]> Protected |
WsgClient |
Used by clients to post multiple strongly typed instances through standard WSG REST API |
postQuery<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, typedConstructor: object, relativeUrlPath: string, queryOptions: RequestQueryOptions): Promise<T extends WsgInstance[]> Protected |
WsgClient |
Used by clients to get strongly typed instances from standard WSG REST queries that return EC JSON instances. |
Properties
Name |
Type |
Description |
|
configRelyingPartyUri Static |
"imjs_connected_context_service_relying_party_uri" = "imjs_connected_context_service_relying_party_uri" |
|
|
searchKey Static |
string |
|
|
Inherited properties
Defined in
Last Updated:
05 June, 2020