Google is committed to advancing racial equity for Black communities. See how.

Class ConferenceError

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(ConferenceErrorType.UNAUTHENTICATED)
    .setAuthenticationUrl(authenticationUrl);

Methods

MethodReturn typeBrief description
setAuthenticationUrl(authenticationUrl)ConferenceErrorIf 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)ConferenceErrorSets 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

NameTypeDescription
authenticationUrlStringThe 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

NameTypeDescription
conferenceErrorTypeConferenceErrorTypeThe type of error to set.

Return

ConferenceError — this object, for chaining