BaseApi
Base Class for Genesys Cloud Client App APIs
since 1.0.0
Hierarchy
- BaseApi
↳ UsersApi
Index
Constructors
Constructors
constructor
\+ new BaseApi(cfg: object): BaseApi
Instantiates the BaseApi
since 1.0.0
Parameters:
▪Default value cfg: object= {}
Optional configuration
Name | Type | Description |
| string | null | The name of the message protocol under which the message will be sent. Default is purecloud-client-apps. |
| string | null | The name of the agent from which the message will be sent. Default is purecloud-client-app-sdk (name of the package). |
| string | null | The version of the agent from which the message will be sent. Default is the version of the package. |
| string | null | The origin (protocol, hostname, and port) of the target PC environment (e.g. https://apps.mypurecloud.com). Default is '*'. |
Returns: BaseApi
