Class ConferenceError
Stay organized with collections
Save and categorize content based on your preferences.
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);
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)
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-03 UTC.
[null,null,["Last updated 2024-12-03 UTC."],[[["\u003cp\u003e\u003ccode\u003eConferenceError\u003c/code\u003e objects represent errors that occur within conferencing add-ons and can be created using \u003ccode\u003eConferenceDataService.newConferenceError()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThese errors have a type, which can be set using \u003ccode\u003esetConferenceErrorType()\u003c/code\u003e, and may require an authentication URL if the type is \u003ccode\u003eAUTHENTICATION\u003c/code\u003e, set using \u003ccode\u003esetAuthenticationUrl()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eIf the error type is \u003ccode\u003eAUTHENTICATION\u003c/code\u003e, 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.\u003c/p\u003e\n"],["\u003cp\u003eBoth \u003ccode\u003esetAuthenticationUrl()\u003c/code\u003e and \u003ccode\u003esetConferenceErrorType()\u003c/code\u003e return the \u003ccode\u003eConferenceError\u003c/code\u003e object itself, enabling method chaining for easier error configuration.\u003c/p\u003e\n"]]],[],null,["# Class ConferenceError\n\nConferenceError\n\nError that occurred in a conferencing add-on. Example usage:\n\n```javascript\nconst conferenceError =\n ConferenceDataService.newConferenceError().setConferenceErrorType(\n ConferenceDataService.ConferenceErrorType.PERMANENT,\n );\n```\nExample with authentication: \n\n```javascript\nconst state = ScriptApp.newStateToken()\n .withMethod('myLoginCallbackFunction')\n .withTimeout(3600)\n .createToken();\n\nconst authenticationUrl = `https://script.google.com/a/google.com/d/${\n ScriptApp.getScriptId()}/usercallback?state=${state}`;\n\nconst conferenceError =\n ConferenceDataService.newConferenceError()\n .setConferenceErrorType(\n ConferenceDataService.ConferenceErrorType.AUTHENTICATION,\n )\n .setAuthenticationUrl(authenticationUrl);\n``` \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------------------------------------------------------|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [setAuthenticationUrl(authenticationUrl)](#setAuthenticationUrl(String)) | [ConferenceError](#) | If the error type is [AUTHENTICATION](/apps-script/reference/conference-data/conference-error-type#AUTHENTICATION), the add-on must provide a URL calling back into the add-on to allow users to log in. |\n| [setConferenceErrorType(conferenceErrorType)](#setConferenceErrorType(ConferenceErrorType)) | [ConferenceError](#) | Sets the error type of this [ConferenceError](#). |\n\nDetailed documentation\n----------------------\n\n### `set``Authentication``Url(authenticationUrl)`\n\nIf the error type is [AUTHENTICATION](/apps-script/reference/conference-data/conference-error-type#AUTHENTICATION), the add-on must\nprovide a URL calling back into the add-on to allow users to log in. The maximum length for\nthis field is 1800 characters.\n\n#### Parameters\n\n| Name | Type | Description |\n|-----------------------|----------|--------------------------------|\n| `authentication``Url` | `String` | The authentication URL to set. |\n\n#### Return\n\n\n[ConferenceError](#) --- this object, for chaining\n\n#### Throws\n\n\n[`Error`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error) --- if the provided URL is not a valid http/https URL or is too\nlong.\n\n*** ** * ** ***\n\n### `set``Conference``Error``Type(conferenceErrorType)`\n\nSets the error type of this [ConferenceError](#).\n\n#### Parameters\n\n| Name | Type | Description |\n|---------------------------|-------------------------------------------------------------------------------------|---------------------------|\n| `conference``Error``Type` | [ConferenceErrorType](/apps-script/reference/conference-data/conference-error-type) | The type of error to set. |\n\n#### Return\n\n\n[ConferenceError](#) --- this object, for chaining"]]
