import EmailCredentialsController from 'itslanguage/administrative-sdk/email-credentials/email-credentials-controller.js'EmailCredentialsController
Controller class for the Email Credentials model.
Constructor Summary
| Public Constructor | ||
| public |
constructor(connection: Connection) |
|
Member Summary
| Private Members | ||
| private |
Object to use for making a connection to the REST API and Websocket server. |
|
Method Summary
| Public Methods | ||
| public |
createEmailCredentials(userId: string, emailCredentials: EmailCredentials): Promise<EmailCredentials> Register credentials to the given user. |
|
Public Constructors
public constructor(connection: Connection) source
Params:
| Name | Type | Attribute | Description |
| connection | Connection | Object to use for making a connection to the REST API and Websocket server. |
Private Members
private _connection: Connection source
Object to use for making a connection to the REST API and Websocket server.
Public Methods
public createEmailCredentials(userId: string, emailCredentials: EmailCredentials): Promise<EmailCredentials> source
Register credentials to the given user. Multiple credentials can be registered to one user.
Params:
| Name | Type | Attribute | Description |
| userId | string | The identifier of the user to register credentials to. |
|
| emailCredentials | EmailCredentials | The credentials to register to the user. |
Throw:
Promise.<Error> |
userId parameter of type "string" is required. |
Promise.<Error> |
emailCredentials parameter of type "EmailCredentials" is required. |
Promise.<Error> |
If the server returned an error. |