Class ConferenceError

AI-generated Key Takeaways

• ConferenceError objects represent errors that occur within conferencing add-ons and can be created using ConferenceDataService.newConferenceError().

• These errors have a type, which can be set using setConferenceErrorType(), and may require an authentication URL if the type is AUTHENTICATION, set using setAuthenticationUrl().

• If the error type is AUTHENTICATION, the provided authentication URL should redirect users back to the add-on for login purposes and should be a valid http/https URL with a maximum length of 1800 characters.

• Both setAuthenticationUrl() and setConferenceErrorType() return the ConferenceError object itself, enabling method chaining for easier error configuration.

ConferenceError

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

const conferenceError =
    ConferenceDataService.newConferenceError().setConferenceErrorType(
        ConferenceDataService.ConferenceErrorType.PERMANENT,
    );

Example with authentication:

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

const authenticationUrl = `https://script.google.com/a/google.com/d/${
    ScriptApp.getScriptId()}/usercallback?state=${state}`;

const 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