Class ConferenceError

ConferenceError

Fehler, der in einem Add-on für Videokonferenzen aufgetreten ist. Nutzungsbeispiel:

const conferenceError =
    ConferenceDataService.newConferenceError().setConferenceErrorType(
        ConferenceDataService.ConferenceErrorType.PERMANENT,
    );
Beispiel mit Authentifizierung:
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);

Methoden

MethodeRückgabetypKurzbeschreibung
setAuthenticationUrl(authenticationUrl)ConferenceErrorWenn der Fehlertyp AUTHENTICATION ist, muss das Add-on eine URL bereitstellen, die zurück zum Add-on verweist, damit sich Nutzer anmelden können.
setConferenceErrorType(conferenceErrorType)ConferenceErrorLegt den Fehlertyp dieses ConferenceError fest.

Detaillierte Dokumentation

setAuthenticationUrl(authenticationUrl)

Wenn der Fehlertyp AUTHENTICATION ist, muss das Add-on eine URL bereitstellen, die zurück zum Add-on verweist, damit sich Nutzer anmelden können. Die maximale Länge für dieses Feld beträgt 1.800 Zeichen.

Parameter

NameTypBeschreibung
authenticationUrlStringDie festzulegende Authentifizierungs-URL.

Rückgabe

ConferenceError – dieses Objekt zur Verkettung

Löst

Error – wenn die angegebene URL keine gültige HTTP-/HTTPS-URL oder zu lang ist.


setConferenceErrorType(conferenceErrorType)

Legt den Fehlertyp dieses ConferenceError fest.

Parameter

NameTypBeschreibung
conferenceErrorTypeConferenceErrorTypeDer festzulegende Fehlertyp.

Rückgabe

ConferenceError – dieses Objekt zur Verkettung