Class Client

Class used to communicate with a CubicWeb instance's API.

Hierarchy

Client

Index

Constructors

Methods

currentUser execute executeTransaction getBinary login logout schema

Constructors

constructor

new Client(apiUrl): Client
Class used to communicate with a CubicWeb instance's API.
Parameters
- apiUrl: string
  
  The API url. It should not include the API version as it will be automatically added. Example: if you can retrieve the schema with https://example.com/api/v1/schema, use https://example.com/api as apiUrl.
Returns Client
- Defined in packages/client/src/api/Client.ts:23

Methods

currentUser

currentUser(): Promise<CurrentUser>
Get the user associated to this client

Returns Promise<CurrentUser>
A promise resolving to the current user
- Defined in packages/client/src/api/Client.ts:84

execute

execute(rql, params?): Promise<ResultSet<readonly ResultSetCell[]>>
Executes the given query and waits for the response.

If binaries are given, the request is automatically sent using multipart/form-data to allow uploading binaries.
Parameters
- rql: string
  
  The RQL query to send
- params: RQLQueryParams = {}
  
  The additional parameters for the request
Returns Promise<ResultSet<readonly ResultSetCell[]>>
A promise with the request's result set
- Defined in packages/client/src/api/Client.ts:41

executeTransaction

executeTransaction(transaction): Promise<TransactionResult>
Executes the given transaction.

If the Transaction object contains binaries, the request is automatically sent using multipart/form-data to allow uploading binaries.
Parameters
- transaction: Transaction
  
  Transaction to execute
Returns Promise<TransactionResult>
A promise returning the transaction result on success
- Defined in packages/client/src/api/Client.ts:97

getBinary

getBinary(eid, attribute): Promise<Blob>
Get the binary for the given entity attribute
Parameters
- eid: number
  
  Entity eid to fetch the binary from
- attribute: string
  
  Attribute on the entity in which the binary is stored
Returns Promise<Blob>
A promise resolving to the binary as a Blob
- Defined in packages/client/src/api/Client.ts:110

login

login(login, password): Promise<boolean>
Tries to log in the user on the configured CubicWeb instance with the given credentials.
Parameters
- login: string
  
  The user login
- password: string
  
  The user password
Returns Promise<boolean>
A promise returning true if the login was successful, false otherwise
- Defined in packages/client/src/api/Client.ts:66

logout

logout(): Promise<void>
Logs out the current user. Will invalidate any authentication cookie active.

Returns Promise<void>
A promise which will resolve when the user is properly logged out
- Defined in packages/client/src/api/Client.ts:75

schema

schema(): Promise<Schema<EntityRawSchemaArray, RelationDefinitionRawSchemaArray<EntityRawSchemaArray>>>
Retrieves the CubicWeb instance's JSON schema.

Returns Promise<Schema<EntityRawSchemaArray, RelationDefinitionRawSchemaArray<EntityRawSchemaArray>>>
The CubicWeb instance's JSON schema.
- Defined in packages/client/src/api/Client.ts:54

Generated using TypeDoc