Class ConferenceError

Error that occurred in a conferencing add-on. Example usage:

var conferenceError = ConferenceDataService.newConferenceError()
    .setConferenceErrorType(ConferenceErrorType.PERMANENT);

Example with authentication:

var state = ScriptApp.newStateToken()
    .withMethod('myLoginCallbackFunction');
    .withTimeout(3600)
    .createToken();

var authenticationUrl = 'https://script.google.com/a/google.com/d/'
    + ScriptApp.getScriptId()
    + '/usercallback?state='
    + state;

var conferenceError = ConferenceDataService.newConferenceError()
    .setConferenceErrorType(ConferenceDataService.ConferenceErrorType.AUTHENTICATION)
    .setAuthenticationUrl(authenticationUrl);

Methods

Method	Return type	Brief description
`setAuthenticationUrl(authenticationUrl)`	`ConferenceError`	If the error type is `AUTHENTICATION`, the add-on must provide a URL calling back into the add-on to allow users to log in.
`setConferenceErrorType(conferenceErrorType)`	`ConferenceError`	Sets the error type of this `ConferenceError`.

Detailed documentation

`setAuthenticationUrl(authenticationUrl)`

If the error type is AUTHENTICATION, the add-on must provide a URL calling back into the add-on to allow users to log in. The maximum length for this field is 1800 characters.

Parameters

Name	Type	Description
`authenticationUrl`	`String`	The authentication URL to set.

Return

ConferenceError — this object, for chaining

Throws

Error — if the provided URL is not a valid http/https URL or is too long.

`setConferenceErrorType(conferenceErrorType)`

Sets the error type of this ConferenceError.

Parameters

Name	Type	Description
`conferenceErrorType`	`ConferenceErrorType`	The type of error to set.

Return

ConferenceError — this object, for chaining