Methods
UUID()
La fonction UUID génère un UUID (Universally Unique Identifier) aléatoire.
- Source:
Returns:
La fonction UUID renvoie un UUID (Universally Unique Identifier) généré aléatoirement à l'aide de la fonction uuid.
_3DSpace_Create_Doc(credentials, dataopt, filenameopt, descopt, onDoneopt, onErroropt)
Cette fonction crée un document dans le 3Dspace à partir des données fournies au format JSON.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles qu'ici « token », « space » et « ctx ».(ex: credentials.space, credentials.tenant, credentials.token) Properties
|
|||||||||||||
data |
String |
<optional> |
Le paramètre data correspond aux données JSON qui doivent être chargées dans le 3Dspace. |
||||||||||||
filename |
String |
<optional> |
Le nom du fichier à créer. |
||||||||||||
desc |
String |
<optional> |
desc est un paramètre de chaîne qui représente la description du document en cours de création dans le 3Dspace. |
||||||||||||
onDone |
function |
<optional> |
Le paramètre onDone est une fonction de rappel qui sera appelée lorsque la requête HTTP sera terminée avec succès. Il prend la réponse comme argument. |
||||||||||||
onError |
function |
<optional> |
Le paramètre onError est une fonction de rappel qui sera appelée s'il y a une erreur lors de l'exécution de la fonction _3dSpace_Create_Doc. Il prend l'objet de réponse comme argument. |
- Source:
Example
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
_3DSpace_bookmark_addSubsciptions(credentials, objectId, personList, eventsList, onDone, onError) → {Promise}
_3DSpace_bookmark_addSubsciptions
Parameters:
Name | Type | Description |
---|---|---|
credentials |
Object | |
objectId |
String | |
personList |
String | |
eventsList |
Array | "NXFolderCreated,NXFolderDeleted,NXContentAdded,NXContentRemoved" |
onDone |
function | |
onError |
function |
- Source:
Returns:
- Type
- Promise
_3DSpace_csrf(credentials, onDone, onError)
Cette fonction JavaScript récupère le TOKEN CSRF d'une application 3DSpace.
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles qu'ici « token » et « space ».(ex: credentials.space, credentials.tenant, credentials.token...). Properties
|
||||||
onDone |
function | Le paramètre |
||||||
onError |
function | Le paramètre |
- Source:
Returns:
la valeur du jeton CSRF, qui est obtenue à partir de la réponse de l'appel HTTP.
Example
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
_3DSpace_download_doc(credentials, onDone, onError) → {Promise}
La fonction _3dspace_download_doc
est une fonction asynchrone qui télécharge un document à partir d'un espace 3D, avec des rappels facultatifs pour le succès et la gestion des erreurs.
Parameters:
Name | Type | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification nécessaires à l'authentification. Il doit avoir les propriétés suivantes: space, token Properties
|
|||||||||||||||
onDone |
function | Le paramètre |
|||||||||||||||
onError |
function | Le paramètre |
- Source:
Returns:
- Type
- Promise
Example
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
_3DSpace_download_multidoc(credentials, objectIdsopt, onDoneopt, onErroropt)
La fonction _3DSpace_download_multidoc
télécharge plusieurs documents à partir d'un espace 3D en
utilisant un token et des objectID donnés.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification nécessaires à l'authentification dans une fonction interne(_3DSpace_get_downloadTicket_multidoc). Il doit avoir les propriétés suivantes: space, token, tenant Properties
|
|||||||||||||||||
objectIds |
String |
<optional> |
Un tableau d'ID d'objet qui doivent être téléchargés à partir du 3DSpace. |
||||||||||||||||
onDone |
function |
<optional> |
Le paramètre |
||||||||||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Examples
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
{tenant:"R1132100968447"}
_3DSpace_file_update(credentials, docIdopt, fileIdopt, dataopt, filenameopt, onDoneopt, onErroropt)
Cette fonction met à jour un fichier dans un espace 3D avec les données et le nom de fichier donnés, en utilisant la protection CSRF.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles qu'ici « token » et « space ».(ex: credentials.space, credentials.tenant, credentials.token...). Properties
|
|||||||
docId |
String |
<optional> |
ID de document du fichier d'espace 3D en cours de mise à jour. |
||||||
fileId |
String |
<optional> |
Le paramètre fileid est l'identifiant unique du fichier qui doit être mis à jour. |
||||||
data |
String |
<optional> |
Ce paramètre représente les données du fichier qui doivent être mises à jour. Il peut se présenter sous la forme d'un format binaire ou texte. |
||||||
filename |
String |
<optional> |
Nom du fichier mis à jour. |
||||||
onDone |
function |
<optional> |
Le paramètre onDone est une fonction de rappel qui sera exécutée lorsque l'opération de mise à jour du fichier sera terminée avec succès. |
||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Example
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
_3DSpace_file_update_csr(credentials, docId, fileId, data, filename, csr, onDoneopt, onErroropt)
Cette fonction met à jour un fichier dans le document du 3DSpace à l'aide d'un jeton CheckinTicket et CSRF.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles qu'ici « token » et « space ».(ex: credentials.space, credentials.tenant, credentials.token...). Properties
|
|||||||
docId |
String | ID du document en cours de mise à jour. |
|||||||
fileId |
String | ID du fichier mis à jour dans le document. |
|||||||
data |
String | Les données binaires du fichier en cours de mise à jour. |
|||||||
filename |
String | Nom du fichier mis à jour. |
|||||||
csr |
String | csr signifie Cross-Site Request Forgery token, qui est une mesure de sécurité utilisée pour empêcher l'accès non autorisé aux applications Web. Il s'agit d'un jeton unique généré par le serveur et envoyé au client, qui est ensuite inclus dans les requêtes ultérieures pour vérifier l'authenticité de la requête. Dans cette fonction, le |
|||||||
onDone |
function |
<optional> |
Le paramètre onDone est une fonction de rappel qui sera exécutée lorsque la fonction se terminera avec succès. Il prend la réponse comme argument. |
||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Example
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
_3DSpace_file_url_csr(credentials, docidopt, csropt, onDoneopt, onErroropt)
Cette fonction envoie une requête PUT à une URL spécifiée avec des en-têtes d'authentification et renvoie une URL de fichier en cas de succès.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles qu'ici « token » et « space ».(ex: credentials.space, credentials.tenant, credentials.token...). Properties
|
|||||||
docid |
String |
<optional> |
L'ID du document pour lequel le ticket de téléchargement de fichier est demandé. |
||||||
csr |
String |
<optional> |
Le paramètre "csr" est un jeton CSRF utilisé à des fins d'authentification et de sécurité. Il est transmis en tant qu'en-tête dans la requête HTTP à l'URL spécifiée. |
||||||
onDone |
function |
<optional> |
Le paramètre onDone est une fonction de rappel qui sera exécutée lorsque la requête HTTP aboutira et que l'URL du fichier sera obtenue. Il prend un argument, qui est l'URL du fichier. |
||||||
onError |
function |
<optional> |
Le paramètre onError est une fonction de rappel qui sera exécutée s'il y a une erreur lors de la requête HTTP. Il est facultatif et peut être laissé indéfini s'il n'est pas nécessaire. |
- Source:
Example
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
_3DSpace_get_csrf(credentials, onDoneopt, onErroropt)
Cette fonction effectue un appel HTTP authentifié pour récupérer le jeton CSRF pour un document de modélisation 3D.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles qu'ici « token » et « space ».(ex: credentials.space, credentials.tenant, credentials.token...). Properties
|
||||||||||
onDone |
function |
<optional> |
Le paramètre onDone est une fonction de rappel qui sera exécutée lorsque la requête HTTP sera terminée avec succès. Il prend un argument, qui correspond aux données de réponse renvoyées par le serveur. |
|||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Example
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
_3DSpace_get_docInfo(credentials, docidopt, onDoneopt, onErroropt)
La fonction _3dSpace_get_docInfo
récupère des informations sur un document dans un espace 3D.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles qu'ici « token » et « space ».(ex: credentials.space, credentials.tenant, credentials.token...). Properties
|
|||||||
docid |
String |
<optional> |
Le paramètre |
||||||
onDone |
function |
<optional> |
Le paramètre |
||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Returns:
La fonction ne renvoie explicitement rien.
Example
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
_3DSpace_get_downloadTicket_multidoc(credentialsopt, objectIdsopt, onNextopt, onDoneopt, onErroropt)
La fonction _3dspace_get_downloadTicket_multidoc
permet de récupérer un ticket de téléchargement
de plusieurs documents dans un espace 3D.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object |
<optional> |
Un objet contenant les informations d'identification nécessaires à l'authentification. Il doit avoir les propriétés suivantes: space, token, tenant Properties
|
||||||||||||||||
objectIds |
String |
<optional> |
Tableau d'ID d'objet pour lesquels le ticket de téléchargement doit être généré. |
||||||||||||||||
onNext |
function |
<optional> |
Une fonction de rappel qui sera appelée après chaque demande de ticket de téléchargement réussie pour chaque objectId. |
||||||||||||||||
onDone |
function |
<optional> |
Le paramètre |
||||||||||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Examples
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
{tenant:"R1132100968447"}
_3DSpace_get_securityContexts(credentials, csopt, roleopt, organizationopt, onDoneopt, onErroropt)
Cette fonction récupère les contextes de sécurité basés sur des paramètres spécifiés à partir d'un hôte donné.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles qu'ici « space ».(ex: credentials.space, credentials.tenant, credentials.token...). Properties
|
|||||||
cs |
String |
<optional> |
Le titre d'un espace de collaboration. |
||||||
role |
String |
<optional> |
Le paramètre de rôle est un paramètre facultatif qui spécifie le rôle de l'utilisateur dans l'espace de collaboration. Si fourni, la fonction filtrera les espaces de collaboration pour trouver celui où l'utilisateur a le rôle spécifié. S'il n'est pas fourni, la fonction utilisera le premier espace de collaboration trouvé. |
||||||
organization |
String |
<optional> |
Nom de l'organisation pour laquelle le contexte de sécurité est récupéré. |
||||||
onDone |
function |
<optional> |
La fonction à appeler lorsque le contexte de sécurité a été récupéré avec succès. Il prend le contexte comme paramètre. |
||||||
onError |
function |
<optional> |
Le paramètre onError est une fonction de rappel qui est appelée si une erreur se produit lors de l'exécution de la fonction. Il prend un argument, qui est le message d'erreur ou l'objet. |
- Source:
Example
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
_3DSpace_get_ticket(credentials, onDoneopt, onErroropt)
La fonction _3DSpace_get_ticket
récupère un ticket d’accès pour un document
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles qu'ici « token » et « space ».(ex: credentials.space, credentials.tenant, credentials.token...). Properties
|
||||||||||
onDone |
function |
<optional> |
Une fonction de rappel qui sera appelée lorsque l'URL du fichier sera récupérée avec succès. Il prend un paramètre, qui est l'URL du fichier. |
|||||||||
onError |
function |
<optional> |
Le paramètre onError est une fonction qui sera appelée s'il y a une erreur lors de l'exécution de la fonction. Il s'agit d'un paramètre facultatif et peut être laissé indéfini s'il n'est pas nécessaire. |
- Source:
Example
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
_3DSpace_lifecycle_changeRevision(credentials, objectId, nextRevision, onDoneopt, onErroropt)
La fonction _3DSpace_lifecycle_changeRevision
est utilisée pour changer la révision d'un objet
dans un espace 3D.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
||||||||||||||||
objectId |
String | Le paramètre objectId représente l'identifiant unique de l'objet dans l'espace 3D. Il est utilisé pour spécifier quelle révision de l'objet doit être modifiée. |
||||||||||||||||
nextRevision |
function | Le paramètre |
||||||||||||||||
onDone |
function |
<optional> |
Une fonction de rappel qui sera appelée lorsque l'opération sera terminée avec succès. Il prend la réponse comme argument. |
|||||||||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Returns:
une promesse.
Examples
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
{tenant:"R1132100968447"}
_3DSpace_lifecycle_changeState(credentials, objectId, nextStateopt, onDoneopt, onErroropt)
Cette fonction permet de changer l'état d'un objet dans un espace 3D.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space » et « ctx ». Properties
|
|||||||||||||
objectId |
String | Le paramètre objectId est l'identifiant de l'objet dont l'état doit être modifié. Il s'agit d'un identifiant unique qui représente un objet spécifique dans le système. |
|||||||||||||
nextState |
function |
<optional> |
Le paramètre |
||||||||||||
onDone |
function |
<optional> |
Une fonction de rappel qui sera appelée lorsque l'opération de changement d'état sera terminée avec succès. Il prend la réponse comme argument. |
||||||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Returns:
une promesse.
Example
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
_3DSpace_lifecycle_getGraph(credentials, objectId, onDoneopt, onErroropt)
La fonction _3DSpace_lifecycle_getGraph
récupère un graphique du cycle de vie d'un objet spatial
3D à l'aide des informations d'identification et de l'ID d'objet fournis.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ».(ex: credentials.space, credentials.tenant, credentials.token...). Properties
|
||||||||||||||||
objectId |
String | Le paramètre objectId est l'identifiant de l'objet pour lequel vous souhaitez récupérer le graphique. Il est utilisé pour spécifier l'objet pour lequel vous souhaitez obtenir le graphique de version. |
||||||||||||||||
onDone |
function |
<optional> |
Une fonction de rappel qui sera appelée lorsque la récupération du graphique sera réussie. Il prend la réponse comme argument. |
|||||||||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Returns:
une promesse.
Examples
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
{tenant:"R1132100968447"}
_3DSpace_lifecycle_getNextRevision(credentials, objectId, onDoneopt, onErroropt)
La fonction _3DSpace_lifecycle_getNextRevision
permet de récupérer la prochaine révision d'un
document dans un espace 3D.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
||||||||||||||||
objectId |
String | Le paramètre |
||||||||||||||||
onDone |
function |
<optional> |
Une fonction de rappel qui sera appelée lorsque l'opération sera terminée avec succès. Il prend la réponse comme argument. |
|||||||||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Returns:
Une promesse est renvoyée.
Examples
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
{tenant:"R1132100968447"}
_3DSpace_lifecycle_getNextStates(credentials, objectId, onDoneopt, onErroropt) → {Promise}
Cette fonction JavaScript récupère les prochains états possibles pour un objet donné dans un espace 3D.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space » et « ctx ». Properties
|
|||||||||||||
objectId |
String | Le paramètre |
|||||||||||||
onDone |
function |
<optional> |
Une fonction de rappel qui sera appelée lorsque la demande sera terminée avec succès. Il recevra la réponse en paramètre. |
||||||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Returns:
- Type
- Promise
Example
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
_3DSwym_buildDirectMessage(credentials, datasopt, onDoneopt, onErroropt)
La fonction _3DSwym_buildDirectMessage
permet d'envoyer un message direct à un ou plusieurs utilisateurs dans un espace plateforme 3DExperience.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
|||||||||||||||||||||||||||||
datas |
Object |
<optional> |
Le paramètre Properties
|
||||||||||||||||||||||||||||
onDone |
function |
<optional> |
Une fonction de rappel qui sera appelée lorsque le message direct sera envoyé avec succès. Il prend un argument, qui est un objet contenant des informations sur la réponse du serveur. |
||||||||||||||||||||||||||||
onError |
function |
<optional> |
Le paramètre |
_3DSwym_deleteIdea(credentials, data, onDoneopt, onErroropt)
La fonction _3DSwym_deleteIdea
est utilisée pour supprimer une idée dans une communauté 3DExperience en utilisant les informations d'identification et les données fournies.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
||||||||||
data |
Le paramètre Properties
|
|||||||||||
onDone |
function |
<optional> |
Le paramètre |
|||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Example
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
_3DSwym_editIdea(credentials, onDoneopt, onErroropt) → {Void}
_3DSwym_editIdea
edit une idée dans 3DSwym.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Objet contenant les informations du besoin de la requête. Properties
|
||||||||||||||||||||||
onDone |
function |
<optional> |
[onDone description] |
|||||||||||||||||||||
onError |
function |
<optional> |
[onError description] |
- Source:
Returns:
- Type
- Void
Example
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
_3DSwym_findCommunityToInstantMSG(credentials, datas, onDone, onError)
La fonction _3DSwym_findCommunityToInstantMSG
est utilisée pour rechercher une communauté dans une
plateforme 3DExperience pour la messagerie instantanée en fonction des informations d'identification
et des données fournies.
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
||||||
datas |
Array | Le paramètre |
||||||
onDone |
function | Le paramètre |
||||||
onError |
function | Le paramètre |
_3DSwym_getAllCommunities(credentials, onDoneopt, onErroropt)
La fonction _3dSwym_getAllCommunities
récupère une liste de communautés à partir d'une plateforme
3D Swym en utilisant les informations d'identification fournies.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
|||||||||||||
onDone |
function |
<optional> |
Une fonction de rappel qui sera appelée une fois l'opération terminée. Il prend la liste des communautés comme paramètre. |
||||||||||||
onError |
function |
<optional> |
Le paramètre |
_3DSwym_getAllListIdeas(credentials, data, onDoneopt, onErroropt)
La fonction _3DSwym_getAllListIdeas
récupère toutes les idées SWYM en utilisant les informations d'identification fournies et les paramètres facultatifs.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il possède les propriétés suivantes : Properties
|
|||||||||||||||||||||
data |
Object | Le paramètre Properties
|
|||||||||||||||||||||
onDone |
function |
<optional> |
Le paramètre |
||||||||||||||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Examples
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
{tenant:"R1132100968447"}.
_3DSwym_getAllNews(credentials, onDoneopt, onErroropt)
La fonction _3DSwym_getAllNews
récupère toutes les actualités d'une plateforme 3DExperience en
utilisant les informations d'identification fournies.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
|||||||
onDone |
function |
<optional> |
Le paramètre |
||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
_3DSwym_getFamiliarPeople(credentials, onDoneopt, onErroropt)
La fonction _3DSwym_getFamiliarPeople
récupère une liste de personnes familières en fonction du
profil de l'utilisateur actuel.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
|||||||
onDone |
function |
<optional> |
Le paramètre |
||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
_3DSwym_getIdeaStatusMaturity(credentials, onDoneopt, onErroropt)
La fonction _3DSwym_getIdeaStatusMaturity
récupère le statut et la maturité d'une idée d'une
communauté 3DExperience à l'aide des informations d'identification fournies.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
||||||||||
onDone |
function |
<optional> |
Le paramètre |
|||||||||
onError |
function |
<optional> |
Le paramètre |
_3DSwym_getMembersCommunity(credentials, idCommu, onDone, onError)
La fonction _3DSwym_getMembersCommunity
récupère une liste des membres d'une communauté en utilisant les informations d'identification et l'ID de communauté fournis.
Parameters:
Name | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
||||||||||||
idCommu |
String | L'identifiant de la communauté dont vous souhaitez récupérer les membres. (ex: "YXdA5x4DSUKtlAi2wmnyTA") |
||||||||||||
onDone |
function | Une fonction de rappel qui sera appelée lorsque l'appel d'API réussit et renvoie les données de réponse. Les données de réponse seront transmises en argument à cette fonction. |
||||||||||||
onError |
function | Le paramètre |
_3DSwym_getOneIdea(credentialsopt, onDoneopt, onErroropt)
Cette fonction JavaScript récupère une idée SWYM à l'aide des informations d'identification et de l'ID de publication fournis.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object |
<optional> |
Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
||||||||||||
onDone |
function |
<optional> |
Le paramètre |
||||||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Example
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
_3DSwym_get_Token(credentials, onDoneopt, onErroropt)
La fonction _3DSwym_get_Token
récupère le token du 3DSwym et effectue des actions supplémentaires si nécessaire. Obligatoire pour chaque appel d'API du Swym.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
|||||||
onDone |
function |
<optional> |
Le paramètre |
||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
_3DSwym_get_currentUser(credentials, onDone, onError)
La fonction _3DSwym_get_currentUser
est utilisée pour récupérer des informations sur l'utilisateur actuel dans une plateforme 3DExperience.
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
||||||
onDone |
function | Le paramètre |
||||||
onError |
function | Le paramètre |
- Source:
_3DSwym_get_findUser(credentials, userLogin, onDoneopt, onErroropt)
La fonction _3DSwym_get_findUser
est utilisée pour rechercher un utilisateur par son identifiant
dans un espace 3DSwym en utilisant les informations d'identification fournies.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
|||||||
userLogin |
String | Le paramètre userLogin est le nom de login de l'utilisateur que vous souhaitez retrouver dans la plateforme 3DSwym. |
|||||||
onDone |
function |
<optional> |
Le paramètre |
||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
_3DSwym_postIdea(credentials, onDoneopt, onErroropt)
La fonction _3dswym_postIdea
est utilisée pour publier une idée dans une communauté 3DExperience.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Le paramètre Properties
|
|||||||||||||||||||
onDone |
function |
<optional> |
Le paramètre |
||||||||||||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
_3DSwym_postIdeaTemplate(credentials, data, onDoneopt, onErroropt)
La fonction _3DSwym_postIdeaTemplate
est utilisée pour publier une idée sur une communauté 3DSwym en utilisant les informations d'identification et les données fournies.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
|||||||||||||||||||||
data |
Object | Le paramètre Properties
|
|||||||||||||||||||||
onDone |
function |
<optional> |
Le paramètre |
||||||||||||||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Example
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
_3DSwym_sendMessageData(credentials, content, onDoneopt, onErroropt)
La fonction _3DSwym_sendMessageData
envoie un message direct avec les informations
d'identification et le contenu donnés, et appelle les rappels onDone
ou onError
en fonction du
succès ou de l'échec de la requête.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
|||||||||||||
content |
Le paramètre Properties
|
||||||||||||||
onDone |
function |
<optional> |
Le paramètre |
||||||||||||
onError |
function |
<optional> |
Le paramètre |
_AppMngt_get_info_user(credentials, id, onDoneopt, onErroropt)
La fonction _AppMngt_get_info_user
effectue un appel HTTP authentifié pour récupérer des
informations sur un utilisateur à partir d'une plateforme spécifique.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
|||||||
id |
String | Le paramètre |
|||||||
onDone |
function |
<optional> |
Le paramètre |
||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
_AppMngt_get_users(credentials, onDoneopt, onErroropt)
La fonction _AppMngt_get_users
effectue un appel HTTP authentifié pour récupérer une liste
d'utilisateurs d'une plateforme spécifiée.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
||||||||||
onDone |
function |
<optional> |
Le paramètre |
|||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
_Iterop_AddOrRemoveRows(credentials, token, tableId, body, onDoneopt, onErroropt) → {Promise}
_Iterop_AddOrRemoveRows
Met a jour les lignes d'une table Business.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
credentials |
Object | credentials. Properties
|
|||||||
token |
String | token iterop. |
|||||||
tableId |
String | ID of the Business Table. |
|||||||
body |
String | JSON string of the rows to add or remove, e.g. {"rowsToAdd": [{"uuid": "..."}, ...], "rowsToRemove": ["...", ...]}. |
|||||||
onDone |
function |
<optional> |
Callback function for successful response. |
||||||
onError |
function |
<optional> |
Callback function for error response. |
- Source:
Returns:
Resolves with the result of the API call.
- Type
- Promise
_Iterop_GetAllDependencyTable(credentials, token, onDoneopt, onErroropt) → {Promise}
Récupère toutes les tables de dépendances.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
credentials |
Object | credentials. Properties
|
|||||||
token |
String | token iterop. |
|||||||
onDone |
function |
<optional> |
Callback function for successful response. |
||||||
onError |
function |
<optional> |
Callback function for error response. |
- Source:
Returns:
Resolves with the result of the API call.
- Type
- Promise
_Iterop_PatchDependencyTable()
(cli) => Create List Items
- Source:
_Iterop_businessTableSearchInRows(credentials, token, tableId, columnsName, body, onDoneopt, onErroropt) → {Promise}
_Iterop_businessTableSearchInRows rows in a Business Table.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
credentials |
Object | credentials. Properties
|
|||||||
token |
String | token iterop. |
|||||||
tableId |
String | ID of the Business Table. |
|||||||
columnsName |
String | List of columns to search on, separated by '+'. |
|||||||
body |
String | JSON string of the filters to apply. |
|||||||
onDone |
function |
<optional> |
Callback function for successful response. |
||||||
onError |
function |
<optional> |
Callback function for error response. |
- Source:
Returns:
Resolves with the result of the API call.
- Type
- Promise
_Iterop_getAllBusinessTables(credentials, token, onDoneopt, onErroropt) → {Promise}
Retrieves all business tables.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
credentials |
Object | credentials. Properties
|
|||||||
token |
String | token iterop. |
|||||||
onDone |
function |
<optional> |
Callback function for successful response. |
||||||
onError |
function |
<optional> |
Callback function for error response. |
- Source:
Returns:
Resolves with the result of the API call.
- Type
- Promise
_Iterop_getOneBusinessTable(credentials, token, tableId, onDoneopt, onErroropt)
Retrieves data for a specific Business Table.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
credentials |
Object | Credentials for authentication. |
|
token |
String | CSRF token for authentication. |
|
tableId |
String | ID of the Business Table to retrieve data from. |
|
onDone |
function |
<optional> |
Callback function to execute upon successful data retrieval. |
onError |
function |
<optional> |
Callback function to execute if an error occurs during retrieval. |
- Source:
_Iterop_getOneBusinessTableRows(credentials, token, tableId, onDoneopt, onErroropt)
Retrieves rows from a specific Business Table based on the table ID.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
credentials |
Object | Credentials for authentication. |
|
token |
String | CSRF token for authentication. |
|
tableId |
String | ID of the Business Table to retrieve rows from. |
|
onDone |
function |
<optional> |
Callback function to execute upon successful retrieval. |
onError |
function |
<optional> |
Callback function to execute if an error occurs during retrieval. |
- Source:
_Iterop_jwtUser() → {function}
_Iterop_jwtUser appel sur l'api et demande un Token lié à l'utilisateur et au tenant.
- Source:
Returns:
callback retournant la réponse de l'api
- Type
- function
_Iterop_runProcess(credentials, token, processKey, body) → {function}
Fonction asynchrone, _Iterop_runProcess
permet de lancer un processus ITEROP
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
credentials |
Object | Informations d'identification du tenant. Properties
|
||||||
token |
String | Le jeton CSRF. |
||||||
processKey |
String | le nom du processus ITEROP. |
||||||
body |
String | le body de la requête, doit être au format String et encodé. @exemple encodeURIComponent(JSON.stringify(body)). |
- Source:
Returns:
Callback contenant le message de retour de l'api
- Type
- function
_Iterop_updateBusinessTable(credentials, token, tableId, body, onDoneopt, onErroropt)
Updates a business table with the provided data.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
credentials |
Object | Credentials for authentication. |
|
token |
String | CSRF token for authentication. |
|
tableId |
String | ID of the table to update. |
|
body |
String | Data to update the table with. |
|
onDone |
function |
<optional> |
Callback function to execute upon successful update. |
onError |
function |
<optional> |
Callback function to execute if an error occurs during the update. |
- Source:
_getPlateformInfos() → {String}
La fonction _getPlateformInfos
récupère les informations sur la plateforme à l'aide du module
PlatformAPI et renvoie les informations dans un objet.
Returns:
un objet appelé "retourAPI" qui contient les propriétés suivantes :
- tenant, Le tenant de la plateforme sur lequel on travaille.
- {Object} user, L'utilisateur connecté à la plateforme...
- {ArrayOfObject} appsConfiguration, liste d'app auquel on accès.
- {String} appConf
- Type
- String
_getPlatformServices(platformId, onComplete, onFailure)
Cette fonction asynchrone obtient les services de la plateforme à l'aide de la bibliothèque i3DXCompassServices et appelle les fonctions onComplete ou onFailure en fonction du résultat.
Parameters:
Name | Type | Description |
---|---|---|
platformId |
ID de la plate-forme pour laquelle les services sont demandés. Si aucun ID de
plate-forme n'est fourni, la fonction tentera de récupérer l'ID à partir d'une valeur de widget. Si
aucun ID n'est trouvé, il sera défini sur |
|
onComplete |
Une fonction de rappel qui sera exécutée lorsque les services de la plateforme seront récupérés avec succès. Il prend les services de plateforme récupérés comme argument. |
|
onFailure |
Le paramètre onFailure est une fonction de rappel qui sera exécutée en cas d'erreur ou d'échec dans l'exécution de la fonction getPlatformServices. Il permet de gérer les erreurs et de fournir un retour d'information approprié à l'utilisateur. |
_httpCallAuthenticated(url, options)
Cette fonction effectue un appel HTTP authentifié à l'aide de la bibliothèque WAFData en de la plateforme.
Parameters:
Name | Type | Description |
---|---|---|
url |
String | L'URL du point de terminaison de l'API que la fonction appellera. |
options |
object | Le paramètre |
_setDraggable(elem, strData, onDrag)
Cette fonction définit un élément comme étant déplaçable et transmet des données et une fonction de rappel à exécuter lorsque le glissement commence (drag and drop).
Parameters:
Name | Type | Description |
---|---|---|
elem |
L'élément HTML qui doit être rendu déplaçable. |
|
strData |
strData est une chaîne qui représente les données associées à l'élément déplaçable. Ces données sont accessibles lors des opérations de glisser-déposer pour fournir des informations supplémentaires sur l'élément déplacé. |
|
onDrag |
onDrag est une fonction de rappel qui sera exécutée au début de l'opération de glissement. Il peut être utilisé pour effectuer toutes les actions nécessaires avant le début de l'opération de glissement, telles que la configuration des données à transférer ou la mise à jour de l'apparence de l'élément déplaçable. |
_setDroppable(elem, drop)
Cette fonction définit un élément comme pouvant être déposé à l'aide de la bibliothèque DataDragAndDrop.
Parameters:
Name | Type | Description |
---|---|---|
elem |
L'élément HTML qui doit être rendu déposable. |
|
drop |
Le paramètre |
_setupTagger(tags, onTaggerFilteropt)
Cette fonction configure un proxy de navigateur de balises avec des balises spécifiées et un événement de filtre facultatif.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
tags |
Le paramètre tags est un tableau de chaînes représentant les balises qui seront utilisées pour filtrer les sujets dans le widget TagNavigatorProxy. |
||
onTaggerFilter |
<optional> |
Le paramètre onTaggerFilter est une fonction de rappel qui sera exécutée lorsque l'utilisateur filtrera les sujets dans le tagger. Il recevra les sujets filtrés en argument. |
addTagToDoc(credentials, obj, onDoneopt, onErroropt)
La fonction addTagToDoc
est utilisée pour ajouter une balise à un document dans un espace 3D en
utilisant les informations d'identification et les informations sur l'objet fournies.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
||||||||||||||||
obj |
Object | Le paramètre Properties
|
||||||||||||||||
onDone |
function |
<optional> |
Le paramètre |
|||||||||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Examples
credentials={space: "https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia", currentUser: { username: "Yan" }, tenant: "R1132100968447"}
obj={objId: "B70C12CDAE0415006579A93200061A14", pred: "what", tag: "testTag"}
chunkArray(obj) → {void}
chunkArray
Divise un tableau en plus petits blocs et appelle une fonction fournie sur chaque bloc.
Parameters:
Name | Type | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
obj |
Object | Un objet contenant le tableau à diviser, la taille de chaque bloc,et la fonction à appeler sur chaque bloc. Properties
|
- Source:
Returns:
Cette fonction ne renvoie rien.
- Type
- void
compass_getListAdditionalApps(credentials, onDone, onError)
La fonction compass_getListAdditionalApps
effectue une requête HTTP GET authentifiée pour
récupérer une liste d'applications supplémentaires en fonction des informations d'identification
fournies.
Parameters:
Name | Type | Description |
---|---|---|
credentials |
Object | Un objet contenant les informations d'identification nécessaires à l'authentification. Il doit avoir les propriétés suivantes : space, token |
onDone |
Le paramètre |
|
onError |
Le paramètre |
Properties:
Name | Type | Description |
---|---|---|
space |
String | (_3DCompass)L'URL du serveur sur lequel l'API est déployée.(ex: 3DSpace, 3DSwym, 3DCompass...) |
tenant |
String | le tenant courant (ex: R1132100968447) |
- Source:
createUserGroups(credentials, datas, onDoneopt, onErroropt)
La fonction createUserGroups
crée un nouveau groupe d'utilisateurs avec les détails et les membres
spécifiés. Attention, l'indexation du UserGroup met du temps.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
|||||||||||||||||||
datas |
Object | Les informations du groupe d'utilisateurs. Properties
|
|||||||||||||||||||
onDone |
function |
<optional> |
Une fonction de rappel qui sera appelée lorsque l'appel d'API réussit et que les groupes d'utilisateurs sont créés. Il recevra les données de réponse comme argument. |
||||||||||||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
dataMixing(credentials, _datas, onDoneopt, onErroropt)
La fonction dataMixing
prend en compte les informations d'identification, les données et les
rappels facultatifs, télécharge les données à partir d'un espace 3D, les mélange avec les données
d'entrée et renvoie les données mélangées.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles qu'ici « token » et « space ».(ex: credentials.space, credentials.tenant, credentials.token...). Properties
|
|||||||||||||
_datas |
Le paramètre |
||||||||||||||
onDone |
function |
<optional> |
Le paramètre |
||||||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Examples
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
{tenant:"R1132100968447"}
deleteUserGroups(credentials, uriopt)
La fonction deleteUserGroups est utilisée pour supprimer des groupes d'utilisateurs à l'aide des informations d'identification et de l'URI fournis.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
|||||||
uri |
String |
<optional> |
Le paramètre |
- Source:
findAdresse(query, onDone, onError)
Il s'agit d'une fonction JavaScript qui utilise l'API-adresse.data.gouv.fr pour rechercher des adresses à partir d'une requête et renvoie les résultats au format JSON.
Parameters:
Name | Type | Description |
---|---|---|
query |
String | L'adresse ou la requête d'emplacement à rechercher dans l'API. |
onDone |
function | onDone est une fonction de rappel qui sera exécutée lorsque l'appel API réussit et renvoie une réponse. Il prend la réponse JSON comme paramètre. |
onError |
function | Le paramètre |
- Source:
formatedMessage(message)
La fonction formatedMessage
renvoie un message formaté avec la date et l'heure actuelles.
Parameters:
Name | Type | Description |
---|---|---|
message |
String | Le paramètre |
Returns:
un message formaté avec la date et l'heure actuelles. Le message est enveloppé dans une balise de paragraphe, suivie d'un saut de ligne et d'une règle horizontale. En dessous, il comprend une phrase indiquant quand le message a été envoyé, y compris la date et l'heure.
getActualTagsOnDoc(credentials, obj, onDoneopt, onErroropt)
La fonction getActualTagsOnDoc
récupère les balises réelles d'un document en utilisant les
informations d'identification et les informations sur l'objet fournies. Appeler depuis addTagToDoc()
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
||||||||||||||||
obj |
Le paramètre Properties
|
|||||||||||||||||
onDone |
function |
<optional> |
Le paramètre |
|||||||||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
getAllContextSecurity(credentials, onDoneopt, onErroropt)
La fonction getAllContextSecurity
effectue une requête HTTP GET authentifiée pour récupérer toutes
les ressources de sécurité du contexte.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles qu'ici « space » et « tenant ».(ex: credentials.space, credentials.tenant). Properties
|
||||||||||
onDone |
function |
<optional> |
Une fonction de rappel qui sera appelée lorsque la requête HTTP sera terminée avec succès. Il prend deux paramètres: "rep" (la réponse JSON analysée) et "headers" (les en-têtes de réponse). |
|||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Examples
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
{tenant:"R1132100968447"}
getCSRFToken(credentials, onDone, onError)
La fonction getCSRFToken
est une fonction asynchrone qui récupère un jeton CSRF à partir d'une URL
spécifiée et appelle le rappel onDone
avec le jeton en cas de succès, ou le rappel onError
avec
une erreur en cas d'échec.
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space » et « ctx ». Properties
|
||||||
onDone |
function | Le paramètre |
||||||
onError |
function | Le paramètre |
- Source:
Example
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
getCommunes(cp, onDone, onError)
Cette fonction récupère une liste de communes en fonction d'un code postal donné à l'aide d'une API d'IGN France.
Parameters:
Name | Type | Description |
---|---|---|
cp |
String | Le paramètre |
onDone |
function | onDone est une fonction de rappel qui sera exécutée lorsque l'appel API réussit et renvoie une réponse. Il prend les données de réponse comme argument et peut être utilisé pour gérer les données dans la fonction appelante. |
onError |
function | Le paramètre |
- Source:
getComplementUG(credentials, uriopt, onDoneopt, onErroropt)
La fonction getComplementUG
effectue une requête GET vers un URI spécifié avec les informations
d'authentification et renvoie la réponse.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
||||||||||
uri |
String |
<optional> |
Le paramètre |
|||||||||
onDone |
function |
<optional> |
Le paramètre |
|||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
getDataFrom3DSpace(credentials, widgetPreference, onDone, onError)
La fonction getDataFrom3DSpace
récupère les données d'un espace 3D en utilisant les informations
d'identification fournies et les préférences du widget, et appelle le rappel onDone
avec la
réponse ou le rappel onError
avec toutes les erreurs rencontrées.
Parameters:
Name | Type | Description |
---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token » et « space ».(ex: credentials.token, credentials.space, credentials.tenant, credentials.ctx) |
widgetPreference |
Le paramètre |
|
onDone |
Une fonction de rappel qui sera appelée lorsque la récupération des données sera réussie. Il prend la réponse comme paramètre. |
|
onError |
Le paramètre |
Properties:
Name | Type | Description |
---|---|---|
space |
L'URL du serveur sur lequel l'API est déployée.(ex: 3DSpace, 3DSwym, 3DCompass...) |
|
token |
Le paramètre token est le jeton CSRF. (headers ex: ENO_CSRF_TOKEN:token) |
getDataFromGouvFr(events, colors)
La fonction getDataFromGouvFr
récupère les données de l'API du gouvernement français pour les
jours fériés et les formate dans une structure de données spécifique.
Parameters:
Name | Type | Description |
---|---|---|
events |
Le paramètre |
|
colors |
Le paramètre |
- Source:
Returns:
les données formatées, qui incluent les événements récupérés depuis le point de terminaison API "https://calendrier.api.gouv.fr/jours-feries/metropole/". Les événements sont formatés dans une structure spécifique et renvoyés sous forme d'objet.
getDatasByTenant(credentials, onDoneopt, onErroropt)
La fonction getDatasByTenant
est une fonction asynchrone qui télécharge une liste de documents à partir du 3DSpace à l'aide des informations d'identification fournies (un ObjectId) et appelle le rappel onDone
avec les données téléchargées ou le rappel onError
avec une erreur le cas échéant. (anciennement getDocuments())
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles qu'ici « token » et « space ».(ex: credentials.space, credentials.tenant, credentials.token...). Properties
|
||||||||||||||||
onDone |
function |
<optional> |
Le paramètre onDone est une fonction de rappel qui sera appelée lorsque les données seront téléchargées avec succès. Il faut un argument, qui correspond aux données téléchargées. |
|||||||||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Examples
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
{tenant:"R1132100968447"}
getDatasFrom3DSpace(credentials, onDoneopt, onErroropt)
La fonction getDatasFrom3DSpace
récupère les données d'un espace 3D en utilisant les informations
d'identification fournies et appelle le rappel onDone
avec les données récupérées ou le rappel
onError
avec une erreur le cas échéant.
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles qu'ici « token » et « space ».(ex: credentials.space, credentials.tenant, credentials.token...). Properties
|
||||||||||||||||
onDone |
function |
<optional> |
Le paramètre |
|||||||||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Examples
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
{tenant:"R1132100968447"}
getDownloadDocument(credentials, docId, onDoneopt, onErroropt)
La fonction getDownloadDocument
est une fonction asynchrone qui récupère un document à télécharger
à partir d'un espace et d'un ID de document spécifiés.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space » et « ctx ». Properties
|
|||||||
docId |
String | L'ID du document du fichier que vous souhaitez télécharger. |
|||||||
onDone |
function |
<optional> |
Le paramètre |
||||||
onError |
function |
<optional> |
Le paramètre |
Returns:
un objet Promesse.
getInfoDocTags(credentials, str, onDone, onError)
La fonction « getInfoDocTags » effectue un appel HTTP pour récupérer des informations sur les documents en fonction des informations d'identification et des identifiants de document fournis.
Parameters:
Name | Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
||||||
str |
String | Le paramètre |
||||||
onDone |
function | Le paramètre |
||||||
onError |
function | Le paramètre |
- Source:
Returns:
La fonction ne renvoie explicitement rien.
getUserGroupsList(credentials, onDoneopt, onErroropt)
La fonction « getUserGroupsList » récupère une liste de groupes d'utilisateurs d'un serveur en utilisant les informations d'identification fournies et appelle la fonction de rappel « onDone » avec la réponse.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
|||||||||||||
onDone |
function |
<optional> |
Une fonction de rappel qui sera appelée lorsque l'opération sera terminée avec succès. Il recevra la réponse en paramètre. |
||||||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
getUsersGroupRules(credentials, onDoneopt, onErroropt)
La fonction getUsersGroupRules
effectue une requête HTTP GET pour récupérer une liste de
responsabilités de groupe pour un groupe d'utilisateurs.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
||||||||||
onDone |
function |
<optional> |
Le paramètre |
|||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
get_3DSpace_csrf(credentials, onDoneopt, onErroropt)
La fonction get_3DSpace_csrf
récupère un jeton CSRF du 3DSpace en utilisant les informations d'identification fournies.(Anciennement loadDatas()) avec ou sans objID
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles qu'ici' « objID », « space ». Properties
|
||||||||||
onDone |
function |
<optional> |
Le paramètre |
|||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
Example
pour le 3DSpace {space:"https://r1132100968447-eu1-space.3dexperience.3ds.com/enovia"}
loopingChunk(obj) → {void}
loopingChunk
Exécute une boucle sur un tableau de chunks, en appelant une fonction fournie sur chaque chunk.
Parameters:
Name | Type | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
obj |
Object | Un objet contenant le tableau de chunks, l'index de démarrage de la boucle et la fonction à appeler sur chaque chunk. Properties
|
- Source:
Returns:
Cette fonction ne renvoie rien.
- Type
- void
patchUserGroups(credentials, uri, datas, onDoneopt, onErroropt)
La fonction patchUserGroups
est utilisée pour mettre à jour les groupes d'utilisateurs en envoyant
une requête PATCH à un URI spécifié avec les données fournies.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
||||||||||
uri |
Le paramètre |
|||||||||||
datas |
ArrayOfObjects | Le paramètre |
||||||||||
datas[0].op |
String | l'opération à réaliser. (ex: "add", "remove", "replace") |
||||||||||
datas[0].field |
String | Ce sur quoi agir (ex: members[], title, description, owner, visibility) |
||||||||||
datas[0].value |
StringOrArray | La nouvelle valeur impactée. Si ce sont des membres value sera un Tableau de String. |
||||||||||
onDone |
function |
<optional> |
Une fonction de rappel qui sera appelée lorsque la requête PATCH sera terminée avec succès. Il recevra la réponse en paramètre. |
|||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
patchUserGroupsControl(credentials, uri, _datas, op, value, onDoneopt, onErroropt)
La fonction patchUserGroupsControl
est utilisée pour mettre à jour le contrôle des groupes
d'utilisateurs en envoyant une requête PATCH à un URI spécifié avec les informations
d'identification et les données fournies.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
||||||||||
uri |
String | Le paramètre |
||||||||||
_datas |
ArrayOfObject | Le paramètre |
||||||||||
op |
String | L'opération de correctif. Il peut être 'add', 'replace', 'remove'. |
||||||||||
value |
Object | Properties
|
||||||||||
onDone |
function |
<optional> |
Le paramètre |
|||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
pushDataIn3DSpace(credentials, dataBase, objectId, onDoneopt, onErroropt)
La fonction « pushDataIn3DSpace » est utilisée pour pousser les données dans le 3DSpace à l'aide des informations d'identification et de l'ID d'objet fournis.
Parameters:
Name | Type | Attributes | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification nécessaires à l'authentification dans une fonction interne(_3DSpace_get_downloadTicket_multidoc). Il doit avoir les propriétés suivantes: space, token, tenant Properties
|
|||||||||
dataBase |
Object | Le paramètre |
|||||||||
objectId |
String | Le paramètre objectId est l'identifiant unique de l'objet dans l'espace 3D où les données seront poussées. |
|||||||||
onDone |
function |
<optional> |
Le paramètre onDone est une fonction de rappel qui sera appelée lorsque les données seront correctement poussées vers l'espace 3D. Il faut un argument, qui est le résultat de l'opération. |
||||||||
onError |
function |
<optional> |
Le paramètre |
readUserGroupControl(credentials, uri, onDoneopt, onErroropt)
La fonction « readUserGroupControl » est utilisée pour récupérer les informations de contrôle de groupe d'utilisateurs à partir d'un URI spécifié à l'aide d'une requête HTTP GET.
Parameters:
Name | Type | Attributes | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
|||||||
uri |
String | Le paramètre |
|||||||
onDone |
function |
<optional> |
Le paramètre |
||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
removeTagToDoc(credentials, obj, onDoneopt, onErroropt)
La fonction removeTagToDoc
est utilisée pour supprimer une balise spécifique d'un document en
utilisant les informations d'identification et les informations sur l'objet fournies.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
credentials |
Object | Un objet contenant les informations d'identification requises pour authentifier la demande. Il inclut généralement des propriétés telles que « token », « space », « tenant » et « ctx ». Properties
|
|||||||||||||
obj |
Object | Le paramètre Properties
|
|||||||||||||
onDone |
function |
<optional> |
Le paramètre |
||||||||||||
onError |
function |
<optional> |
Le paramètre |
- Source:
sayHello(_name) → {String}
Fonction Test permettant de tester l'installation de la librairie
Parameters:
Name | Type | Description |
---|---|---|
_name |
String | une simple chaine |
- Source:
Returns:
- Type
- String
updateEvent(events, data, addopt)
La fonction updateEvent
met à jour un tableau d'événements en ajoutant ou en supprimant un
événement en fonction d'une condition donnée.
Parameters:
Name | Type | Attributes | Default | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
events |
Array | (store.loadedEvents)Une panoplie d'événements. Chaque événement est un objet avec des propriétés telles que uuid, start, end, etc. |
||||||||||
data |
Object | Le paramètre Properties
|
||||||||||
add |
Boolean |
<optional> |
true | Le paramètre "add" est une valeur booléenne qui détermine s'il faut ajouter ou mettre à jour un événement dans le tableau des événements. Si add est vrai, la fonction ajoutera l'événement au tableau s'il n'existe pas déjà. Si add est faux, la fonction mettra à jour l'événement existant dans le tableau |
- Source:
Returns:
le tableau db
(store.loadedEvents) mis à jour.