Class ConferenceError

ConferenceError

Erreur survenue dans un module complémentaire de visioconférence. Exemple d'utilisation :

const conferenceError =
    ConferenceDataService.newConferenceError().setConferenceErrorType(
        ConferenceDataService.ConferenceErrorType.PERMANENT,
    );
Exemple avec authentification :
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);

Méthodes

MéthodeType renvoyéBrève description
setAuthenticationUrl(authenticationUrl)ConferenceErrorSi le type d'erreur est AUTHENTICATION, le module complémentaire doit fournir une URL de rappel dans le module complémentaire pour permettre aux utilisateurs de se connecter.
setConferenceErrorType(conferenceErrorType)ConferenceErrorDéfinit le type d'erreur de ce ConferenceError.

Documentation détaillée

setAuthenticationUrl(authenticationUrl)

Si le type d'erreur est AUTHENTICATION, le module complémentaire doit fournir une URL de rappel dans le module complémentaire pour permettre aux utilisateurs de se connecter. La longueur maximale de ce champ est de 1 800 caractères.

Paramètres

NomTypeDescription
authenticationUrlStringURL d'authentification à définir.

Renvois

ConferenceError : cet objet, pour le chaînage

Génère

Error : si l'URL fournie n'est pas une URL HTTP/HTTPS valide ou est trop longue.


setConferenceErrorType(conferenceErrorType)

Définit le type d'erreur de ce ConferenceError.

Paramètres

NomTypeDescription
conferenceErrorTypeConferenceErrorTypeType d'erreur à définir.

Renvois

ConferenceError : cet objet, pour le chaînage