WsgClient Class

Beta

Base class for Client implementations of services that are based on WSG

Extends

Extended by

Methods

Name Description
constructor(apiVersion: string): WsgClient Protected Creates an instance of Client.  
deleteInstance<T extends WsgInstance>(requestContext: AuthorizedClientRequestContext, relativeUrlPath: string, instance?: T, requestOptions?: WsgRequestOptions): Promise<void> Protected 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 Used by clients to get strongly typed instances from standard WSG REST queries that return EC JSON instances.  
getRelyingPartyUrl(): string ProtectedAbstract Implemented by clients to specify the relyingPartyUrl for the service.  
getUrl(requestContext: ClientRequestContext, excludeApiVersion?: false | true): Promise<string> 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 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 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 Used by clients to get strongly typed instances from standard WSG REST queries that return EC JSON instances.  
setupOptionDefaults(options: RequestOptions): Promise<void> Protected Augments request options with defaults returned by the DefaultWsgRequestOptionsProvider.  

Inherited methods

Name Inherited from Description
delete(requestContext: AuthorizedClientRequestContext, relativeUrlPath: string): Promise<void> Protected Client used by clients to send delete requests
getUrlSearchKey(): string ProtectedAbstract Client Implemented by clients to specify the name/key to query the service URLs from
the URL Discovery Service ("Buddi")

Properties

Name Type Description
_url Protected undefined | string    
apiVersion ConstructorProperty string ApiVersion if the service supports it  
configHostRelyingPartyUri Static "imjs_default_relying_party_uri" = "imjs_default_relying_party_uri"    
configUseHostRelyingPartyUriAsFallback Static "imjs_use_default_relying_party_uri_as_fallback" = "imjs_use_default_relying_party_uri_as_fallback"    

Defined in

Last Updated: 09 July, 2019