Compilateur permettant de créer des objets ConferenceData
.
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addConferenceParameter(conferenceParameter) | ConferenceDataBuilder | Ajoute un ConferenceParameter à ce ConferenceData . |
addEntryPoint(entryPoint) | ConferenceDataBuilder | Ajoute un EntryPoint à ce ConferenceData . |
build() | ConferenceData | Compile et valide le ConferenceData . |
setConferenceId(conferenceId) | ConferenceDataBuilder | Définit l'ID de conférence de ConferenceData . |
setConferenceSolutionId(conferenceSolutionId) | ConferenceDataBuilder | Définit l'ID de solution de conférence défini dans le fichier manifeste du module complémentaire. |
setError(conferenceError) | ConferenceDataBuilder | Définit le ConferenceError de ce ConferenceData , indiquant que la conférence n'a pas pu être créée. |
setNotes(notes) | ConferenceDataBuilder | Définit les notes supplémentaires de la propriété ConferenceData , comme les instructions de l'administrateur ou les mentions légales. |
Documentation détaillée
addConferenceParameter(conferenceParameter)
Ajoute un ConferenceParameter
à ce ConferenceData
. Le nombre maximal de paramètres par ConferenceData
est de 300.
Paramètres
Nom | Type | Description |
---|---|---|
conferenceParameter | ConferenceParameter | Paramètre à ajouter. |
Aller-retour
ConferenceDataBuilder
: cet outil de création, pour le chaînage
Génère
Error
: si le paramètre de conférence fourni n'est pas valide ou si trop de paramètres de conférence ont été ajoutés
addEntryPoint(entryPoint)
Ajoute un EntryPoint
à ce ConferenceData
. Le nombre maximal de points d'entrée par ConferenceData
est de 300.
Paramètres
Nom | Type | Description |
---|---|---|
entryPoint | EntryPoint | Point d'entrée à ajouter. |
Aller-retour
ConferenceDataBuilder
: cet outil de création, pour le chaînage
Génère
Error
: si le point d'entrée fourni n'est pas valide ou si trop de points d'entrée ont été ajoutés
build()
Compile et valide le ConferenceData
.
Aller-retour
ConferenceData
: données de conférence validées
Génère
Error
: si les données de conférence construites ne sont pas valides
setConferenceId(conferenceId)
Définit l'ID de conférence de ConferenceData
. La longueur maximale de ce champ est de 512 caractères.
Paramètres
Nom | Type | Description |
---|---|---|
conferenceId | String | ID à définir. |
Aller-retour
ConferenceDataBuilder
: cet outil de création, pour le chaînage
Génère
Error
: si l'ID de conférence fourni est trop long
setConferenceSolutionId(conferenceSolutionId)
Définit l'ID de solution de conférence défini dans le fichier manifeste du module complémentaire. La valeur doit être spécifiée et renseigner le nom de la conférence et la valeur iconUrl.
Notez que ce champ est obligatoire pour les modules complémentaires G Suite, mais qu'il est ignoré pour les modules complémentaires de visioconférence.
Paramètres
Nom | Type | Description |
---|---|---|
conferenceSolutionId | String | ID correspondant au fichier manifeste. |
Aller-retour
ConferenceDataBuilder
: cet outil de création, pour le chaînage
Génère
Error
: si l'ID de solution de conférence fourni est trop long La longueur maximale de ce champ est de 512 caractères.
setError(conferenceError)
Définit le ConferenceError
de ce ConferenceData
, indiquant que la conférence n'a pas pu être créée.
Paramètres
Nom | Type | Description |
---|---|---|
conferenceError | ConferenceError | Erreur à définir. |
Aller-retour
ConferenceDataBuilder
: cet outil de création, pour le chaînage
Génère
Error
: si l'erreur fournie n'est pas valide
setNotes(notes)
Définit les notes supplémentaires de la propriété ConferenceData
, comme les instructions de l'administrateur ou les mentions légales. Peut contenir du code HTML. La longueur maximale de ce champ est de 2 048 caractères.
Paramètres
Nom | Type | Description |
---|---|---|
notes | String | Notes supplémentaires à définir. |
Aller-retour
ConferenceDataBuilder
: cet outil de création, pour le chaînage
Génère
Error
: si les notes fournies sont trop longues.