---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# openFrameAPI : client

# openFrameAPI : client {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 13 minutes de lecture

openFrameAPI fournit des méthodes qui interagissent avec OpenFrame. OpenFrame est un cadre omniprésent que les partenaires de communication peuvent utiliser pour intégrer leurs systèmes dans la ServiceNow plateforme.

L'un des besoins de base est la capacité de connecter et de fournir du code provenant de différents domaines et pouvant se connecter de manière fluide aux sous-systèmes partenaires. Cette connexion inter-domaine est nécessaire pour maintenir les connexions et les rappels inscrits dans les systèmes de communication sans aucun problème inter-domaine.  
OpenFrame comporte deux parties importantes : une qui existe dans l'application ServiceNow (appelée TopFrame) et cette API, qui provient de l'application partenaire. Cette API possède les méthodes nécessaires pour communiquer avec TopFrame et contrôler les fonctionnalités visuelles d'OpenFrame.  
Remarque :  
Pour rester à jour vis-à-vis de la bibliothèque OpenFrame, utilisez la ressource URI suivante : https://\[instance servicenow\]/scripts/openframe/latest/openFrameAPI.min.js.

## openFrameAPI : getAWAAgentPresence(réussite de la chaîne, échec de la chaîne) {#ariaid-title2}

Renvoie l'état de présence actuel de l'agent connecté.
{#openFrameAPI-getAWAPresense_S_S__table_z1t_mgn_sbc__entry__3}

| Nom | Type | Description |
|-|-|-|
| succès | Chaîne | Si la méthode réussit, nom de la fonction de rappel à appeler. |
| échec | Chaîne | En cas d'échec de la méthode, nom de la fonction de rappel à invoquer. |
[Tableau 1. Paramètres]

{#openFrameAPI-getAWAPresense_S_S__table_z1t_mgn_sbc} {#openFrameAPI-getAWAPresense_S_S__table_abt_mgn_sbc__entry__2}

| Type | Description |
|-|-|
| presence | Résultats transmis à la fonction de rappel de réussite par l'infrastructure openFrame. Type de données : objet "presence": { "available": Boolean, "channels": [Array], "name": "String", "sys_id": "String" } |
| presence.available | Marqueur indiquant si l'agent associé est disponible. Valeurs valides : * true : l'agent est disponible. * faux : l'agent n'est pas disponible. Type de données : booléennes |
| presence.channels | Liste des canaux de communication disponibles avec l'agent. Type de données : tableau d'objets "channels": [ { "available": Boolean, "name": "String", "restrict_update": Boolean, "service_channel_type": "String", "sys_id": "String" } ] |
| presence.channels.available | Marqueur indiquant si le canal est disponible. Valeurs valides : * true : le canal est disponible. * false : le canal n'est pas disponible. Type de données Booléen |
| presence.channels.name | Nom du canal, par exemple Messagerie instantanée ou Téléphone. Type de données : chaîne |
| presence.channels.restrict_update | Marqueur indiquant si l'utilisateur peut restreindre les mises à jour du canal. Valeurs valides : * true : l'utilisateur peut restreindre les mises à jour du canal. * false : l'utilisateur ne peut pas restreindre les mises à jour du canal. Type de données Booléen |
| presence.channels.service_channel_type | Type du canal de service. Type de données : chaîne |
| presence.channels.sys_id | Sys_id de l'enregistrement du canal. Situé dans la table Canaux de service \[awa_service_channel\]. Type de données : chaîne |
| presence.name | Nom de l'état de présence de l'agent. Type de données : chaîne |
| presence.sys_id | Sys_id de l'enregistrement de l'état de présence. Situé dans la table États de présence \[awa_presence_state\]. Type de données : chaîne |
[Tableau 2. Renvoie]

{#openFrameAPI-getAWAPresense_S_S__table_abt_mgn_sbc}  
L'exemple de code suivant montre comment appeler cette méthode.

    function failure(data)
    {
      console.log("failure: " + JSON.stringify(data));
    }
     
    function success(data)
    {
      console.log("success: " + JSON.stringify(data));
    }
     
    openFrameAPI.getAWAAgentPresence(success, failure)

Réponse à la fonction de rappel de réussite :

    success: { 
      "presence": { 
        "name": "Available", 
        "sys_id": "0b10223c57a313005baaaa65ef94f970", 
        "available": true, 
        "channels": [ 
          { 
            "name": "Chat", 
            "available": true, 
            "sys_id": "27f675e3739713004a905ee515f6a7c3", 
            "restrict_update": false, 
            "service_channel_type": "chat" 
          } 
        ] 
      } 
    }

## openFrameAPI - hide() {#ariaid-title3}

Masque l'OpenFrame dans le TopFrame.
{#r_openFrameAPI-hide__table_yzb_mxx_kt__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 3. Paramètres]

{#r_openFrameAPI-hide__table_yzb_mxx_kt} {#r_openFrameAPI-hide__table_zzb_mxx_kt__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 4. Renvoie]

{#r_openFrameAPI-hide__table_zzb_mxx_kt}  

    openFrameAPI.hide()

## openFrameAPI - init(configuration d'objet, fonction successCallback, fonction failureCallback) {#ariaid-title4}

Initialise OpenFrame. Il doit s'agir de la première méthode que vous appelez.
Cette méthode initialise la communication avec TopFrame et initialise tous les éléments visuels transmis dans le config paramètre.
{#r_openFrameAPI-init_Object_Object_Object__table_vz3_jyw_kt__entry__3}

| Nom | Type | Description |
|-|-|-|
| configuration | Objet | Paires nom-valeur à utiliser pendant le processus d'initialisation. Clés possibles : * hauteur * subTitle * Titre * Icône du titre * largeur Toutes les clés sont facultatives. Transmettez un objet vide si vous ne souhaitez pas définir ces paires clé-valeur. |
| successCallback | function | Nom de la fonction de rappel à utiliser en cas de réussite de la méthode init . La [configuration OpenFrame](https://www.servicenow.com/docs/access?context=t_CreateAnOpenFrameConfiguration&version=xanadu&pubname=xanadu-customer-service-management&ft:locale=en-US) stockée dans le système est transmise en tant que paramètre à la fonction de rappel. |
| failureCallback | function | Nom de la fonction de rappel à utiliser en cas d'échec de la méthode init. |
[Tableau 5. Paramètres]

{#r_openFrameAPI-init_Object_Object_Object__table_vz3_jyw_kt} {#r_openFrameAPI-init_Object_Object_Object__table_wz3_jyw_kt__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 6. Renvoie]

{#r_openFrameAPI-init_Object_Object_Object__table_wz3_jyw_kt}  

    var config = {
    height: 300,
    width: 200
    }
    function handleCommunicationEvent(context) {
    console.log("Communication from Topframe", context);
    }
    function initSuccess(snConfig) {
    console.log("openframe configuration", snConfig);
    //register for communication event from TopFrame
    openFrameAPI.subscribe(openFrameAPI.EVENTS.COMMUNICATION_EVENT,
    handleCommunicationEvent);
    }
    function initFailure(error) {
    console.log("OpenFrame init failed...", error);
    }
    openFrameAPI.init(config, initSuccess, initFailure);

## openFrameAPI - isVisible(fonction de rappel) {#ariaid-title5}

Vérifie si l'OpenFrame est visible dans le TopFrame.
{#r_openFrameAPI-isVisible_Object_Object__table_zdj_ygy_kt__entry__3}

| Nom | Type | Description |
|-|-|-|
| rappel | function | La fonction de rappel reçoit un paramètre avec une valeur vrai ou faux. Vrai si OpenFrame est visible et faux si elle n'est pas visible. |
[Tableau 7. Paramètres]

{#r_openFrameAPI-isVisible_Object_Object__table_zdj_ygy_kt} {#r_openFrameAPI-isVisible_Object_Object__table_a2j_ygy_kt__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 8. Renvoie]

{#r_openFrameAPI-isVisible_Object_Object__table_a2j_ygy_kt}  

    function callback(isVisible) {
    console.log(isVisible)
    }
    openFrameAPI.isVisible(callback)

## openFrameAPI - openCustomURL(détails de la chaîne) {#ariaid-title6}

Ouvre une URL personnalisée dans l'interface UI16.
{#r_openFrameAPI-openCustomURL__table_ob3_ryd_lt__entry__3}

| Nom | Type | Description |
|-|-|-|
| URL | Chaîne | Texte de l'URL personnalisée. Taille maximale : 2 083 caractères |
[Tableau 9. Paramètres]

{#r_openFrameAPI-openCustomURL__table_ob3_ryd_lt} {#r_openFrameAPI-openCustomURL__table_pb3_ryd_lt__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 10. Renvoie]

{#r_openFrameAPI-openCustomURL__table_pb3_ryd_lt}  

    openFrameAPI.openCustomURL('10_cool_things.do');

## openFrameAPI - openServiceNowForm(détails de l'objet) {#ariaid-title7}

Ouvre une URL de formulaire.
Lorsqu'un agent reçoit un appel entrant, la fenêtre OpenFrame affiche des informations telles que le compte, le contact ou le consommateur. Cliquer sur un lien dans la fenêtre OpenFrame affiche l'enregistrement correspondant.

* Dans l'interface de la plateforme, cette API ouvre une URL de formulaire dans TopFrame.
* Pour Espace de travail d'agent, cette API prend en charge la gestion de l'onglet d'interaction. Dans Espace de travail d'agent, un enregistrement d'interaction s'ouvre dans un onglet parent et l'enregistrement d'entité spécifié s'ouvre dans un onglet enfant sous l'onglet d'interaction.
{#r_openFrameAPI-openServiceNowForm_Object__ul_mwy_4nc_lhb} {#r_openFrameAPI-openServiceNowForm_Object__table_ulq_vwd_lt__entry__3}

| Nom | Type | Description |
|-|-|-|
| Détails | Objet | Paires de valeurs clés qui identifient l'URL de formulaire à ouvrir. "details": { "entity": "String"; "interaction_sys_id": "String"; "query": "String" } |
| details.entity | Chaîne | Nom de la table ou de l'entité. |
| details.interaction_sys_id | Chaîne | Facultatif. Sys_id de l'enregistrement d'interaction à ouvrir en tant qu'onglet parent dans Espace de travail d'agent. Remarque : dans l'interface de la plateforme, le interaction_sys_id est ignoré. |
| details.query | Chaîne | Requête pour identifier l'enregistrement à ouvrir, telle que : `query:'sys_id=<record_sys_id>'`. |
[Tableau 11. Paramètres]

{#r_openFrameAPI-openServiceNowForm_Object__table_ulq_vwd_lt} {#r_openFrameAPI-openServiceNowForm_Object__table_vlq_vwd_lt__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 12. Renvoie]

{#r_openFrameAPI-openServiceNowForm_Object__table_vlq_vwd_lt}  
L'exemple suivant montre l'utilisation de base dans la plateforme :

    openFrameAPI.openServiceNowForm({entity:'customer_account', 
    query:'sys_id=447832786f0331003b3c498f5d3ee452', 'interaction_sys_id':'3be092313b711300758ce9b534efc4dd'});

L'exemple suivant montre comment utiliser le query paramètre pour créer un nouvel enregistrement avec les données fournies dans le formulaire à l'aide de sysparm_query et d'une requête codée pour renseigner les champs Prénom et Nom dans l'espace de travail :

    openFrameAPI.openServiceNowForm({ entity: 'sys_user',
    query: 'sys_id=-1&sysparm_query=first_name=Ivan^last_name=Greggor' });

## openFrameAPI : openServiceNowFormwithChildTabIf() {#ariaid-title8}

Ouvre un ServiceNow formulaire avec un onglet enfant s'il est invoqué dans un espace de travail ou ouvre une entité s'il est invoqué dans l'interface UI16.
{#openFrameAPI-openSNFormwithChildTab__table_j13_hwv_hyb__entry__3}

| Nom | Type | Description |
|-|-|-|
| openServiceNowFormwithChildTab | Objet | Définit si l'API ouvre un ServiceNow formulaire avec un onglet enfant si elle est invoquée dans un espace de travail ou ouvre une entité si elle est invoquée dans l'interface UI16. openFrameAPI.openServiceNowFormwithChildTablf({ entity: "String", sys_id: "String", parent_entity: "String", parent_entity_sys_id: "String", |
| openServiceNowFormwithChildTab.entity | Chaîne | Nom de la table. |
| openServiceNowFormwithChildTab.sys_id | Chaîne | Sys_id de l'enregistrement à ouvrir. |
| openServiceNowFormwithChildTab.parent_entity | Chaîne | Nom de la table à ouvrir en tant qu'onglet parent. |
| openServiceNowFormwithChildTab.parent_entity_sys_id | Chaîne | Sys_id de l'enregistrement parent à ouvrir. |
[Tableau 13. Paramètres]

{#openFrameAPI-openSNFormwithChildTab__table_j13_hwv_hyb} {#openFrameAPI-openSNFormwithChildTab__table_k13_hwv_hyb__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 14. Renvoie]

{#openFrameAPI-openSNFormwithChildTab__table_k13_hwv_hyb}  
L'exemple suivant ouvre l'entité parente en tant qu'onglet parent sur un espace de travail configuré ou ouvre uniquement l'entité si elle est invoquée dans UI16.

    openFrameAPI.openServiceNowFormwithChildTablf({
    	entity: "customer_account", 
    	sys_id: "447832786f0331003b3c498f5d3ee452", 	
    	parent_entity: "interaction", 
    	parent_entity_sys_id: "3be092313b711300758ce9b534efc4dd"
    });

## openFrameAPI - openServiceNowList(détails de l'objet) {#ariaid-title9}

Ouvre une URL de liste dans l'interface UI16.
{#r_openFrameAPI-openServiceNowList_Object__table_fpq_5xd_lt__entry__3}

| Nom | Type | Description |
|-|-|-|
| Détails | Objet | Paires de valeurs clés qui décrivent le contenu à utiliser lors de l'ouverture de l'URL de la liste. Valeurs valides : * Entité : Nom de la table * requête : [chaîne de requête codée](https://www.servicenow.com/docs/access?context=c_EncodedQueryStrings&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US) {#r_openFrameAPI-openServiceNowList_Object__ul_ndm_fxd_lt} |
[Tableau 15. Paramètres]

{#r_openFrameAPI-openServiceNowList_Object__table_fpq_5xd_lt} {#r_openFrameAPI-openServiceNowList_Object__table_gpq_5xd_lt__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 16. Renvoie]

{#r_openFrameAPI-openServiceNowList_Object__table_gpq_5xd_lt}  

    openFrameAPI.openServiceNowList({entity:'case', query:'active=true'});

## openFrameAPI - setFrameMode(mode) {#ariaid-title10}

Définit le mode de l'OpenFrame.
Le mode passé dans cette API :

* définit l'icône appropriée dans l'en-tête : réduire ou développer
* déclenche l'événement pertinent pour le CTI :
  * openFrameAPI.EVENTS.COLLAPSE
  * openFrameAPI.EVENTS.EXPAND
  {#r_openFrameAPI-setFrameMode__ul_sjp_rgw_5fb}
{#r_openFrameAPI-setFrameMode__ul_vnq_4gw_5fb}
{#r_openFrameAPI-setFrameMode__table_yzb_mxx_kt__entry__3}

| Nom | Type | Description |
|-|-|-|
| Mode | Chaîne | Définissez le mode de l'OpenFrame. Options énumérées : 1. openFrameAPI.FRAME_MODE.COLLAPSE 2. openFrameAPI.FRAME_MODE.EXPAND {#r_openFrameAPI-setFrameMode__ol_yjp_3gw_5fb} |
[Tableau 17. Paramètres]

{#r_openFrameAPI-setFrameMode__table_yzb_mxx_kt} {#r_openFrameAPI-setFrameMode__table_zzb_mxx_kt__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 18. Renvoie]

{#r_openFrameAPI-setFrameMode__table_zzb_mxx_kt}  

    openFrameAPI.setFrameMode(openFrameAPI.FRAME_MODE.COLLAPSE);

## openFrameAPI - setHeight(hauteur) {#ariaid-title11}

Définit la hauteur de l'OpenFrame.
{#r_openFrameAPI-setHeight__table_yzb_mxx_kt__entry__3}

| Nom | Type | Description |
|-|-|-|
| Hauteur | Numéro | Hauteur en pixels |
[Tableau 19. Paramètres]

{#r_openFrameAPI-setHeight__table_yzb_mxx_kt} {#r_openFrameAPI-setHeight__table_zzb_mxx_kt__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 20. Renvoie]

{#r_openFrameAPI-setHeight__table_zzb_mxx_kt}  

    openFrameAPI.setHeight(100);

## openFrameAPI - setIcons(icônes de tableau) {#ariaid-title12}

Définit les icônes dans l'en-tête OpenFrame qui sont placées en regard de l'icône de fermeture.
{#r_openFrameAPI-setIcons_Array__table_dg3_lny_kt__entry__3}

| Nom | Type | Description |
|-|-|-|
| icônes | Tableau d'objets | Liste de configurations d'icônes, où chaque configuration d'icône est un objet avec des valeurs imageURLclés , imageTitleet tout autre contexte nécessaire. Taille maximale : les icônes peuvent être un maximum de 16x16 pixels. Les images plus grandes sont automatiquement ajustées à ce maximum. |
[Tableau 21. Paramètres]

{#r_openFrameAPI-setIcons_Array__table_dg3_lny_kt} {#r_openFrameAPI-setIcons_Array__table_eg3_lny_kt__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 22. Renvoie]

{#r_openFrameAPI-setIcons_Array__table_eg3_lny_kt}  

    openFrameAPI.setIcons([{imageURL:'https://mydomian.com/image/mute.png',
    imageTitle:'mute', id:101}, {imageURL:'https://mydomian.com/image/hold.png',
    imageTitle:'hold', id:102}]);

## openFrameAPI - setPresenceIndicator(présence) {#ariaid-title13}

Définit l'indicateur de présence pour qu'il affiche la disponibilité de l'agent dans un espace de travail.
Pour plus d'informations sur la configuration [d'OpenFrame, consultez Créer une configuration OpenFrame](https://www.servicenow.com/docs/access?context=t_CreateAnOpenFrameConfiguration&version=xanadu&pubname=xanadu-customer-service-management&ft:locale=en-US)
{#openFrameAPI-setPresenceIndicator__table_o4l_p1c_jhb__entry__3}

| Nom | Type | Description |
|-|-|-|
| État | Chaîne | État de présence de l'agent. États par défaut : * Disponible * Absent * Hors ligne {#openFrameAPI-setPresenceIndicator__ul_bws_ldg_d3b} Vous pouvez également indiquer des états personnalisés. |
| couleur | Chaîne | Couleur de l'indicateur de présence dans l'espace de travail. Couleurs prises en charge : * rouge * orange * gris * vert {#openFrameAPI-setPresenceIndicator__ul_xwr_xbg_d3b} |
[Tableau 23. Paramètres]

{#openFrameAPI-setPresenceIndicator__table_o4l_p1c_jhb} {#openFrameAPI-setPresenceIndicator__table_p4l_p1c_jhb__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 24. Renvoie]

{#openFrameAPI-setPresenceIndicator__table_p4l_p1c_jhb}  

    openframeAPI.setPresenceIndicator('Available', 'green');

## openFrameAPI - setSize(largeur en nombre, hauteur en nombre) {#ariaid-title14}

Définit la taille de l'OpenFrame.
{#r_openFrameAPI-setSize_Number_Number__table_vvk_5jy_kt__entry__3}

| Nom | Type | Description |
|-|-|-|
| largeur | Numéro | Doit avoir une valeur supérieure à zéro. |
| hauteur | Numéro | Doit avoir une valeur supérieure à zéro. |
[Tableau 25. Paramètres]

{#r_openFrameAPI-setSize_Number_Number__table_vvk_5jy_kt} {#r_openFrameAPI-setSize_Number_Number__table_wvk_5jy_kt__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 26. Renvoie]

{#r_openFrameAPI-setSize_Number_Number__table_wvk_5jy_kt}  

    openFrameAPI.setSize(300, 370);

## openFrameAPI - setSubtitle(sous-titre de la chaîne) {#ariaid-title15}

Définit le sous-titre d'OpenFrame.
{#r_openFrameAPI-setSubtitle_String__table_ztd_hjy_kt__entry__3}

| Nom | Type | Description |
|-|-|-|
| sous-titre | Chaîne | Une chaîne de 256 caractères ou moins. |
[Tableau 27. Paramètres]

{#r_openFrameAPI-setSubtitle_String__table_ztd_hjy_kt} {#r_openFrameAPI-setSubtitle_String__table_a5d_hjy_kt__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 28. Renvoie]

{#r_openFrameAPI-setSubtitle_String__table_a5d_hjy_kt}  

    openFrameAPI.setSubtitle('+18888888888');

## openFrameAPI - setTitle(titre de la chaîne) {#ariaid-title16}

Définit le titre de l'OpenFrame.
{#r_openFrameAPI-setTitle_String__table_jbl_w3y_kt__entry__3}

| Nom | Type | Description |
|-|-|-|
| Titre | Chaîne | Une chaîne de 256 caractères ou moins. |
[Tableau 29. Paramètres]

{#r_openFrameAPI-setTitle_String__table_jbl_w3y_kt} {#r_openFrameAPI-setTitle_String__table_kbl_w3y_kt__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 30. Renvoie]

{#r_openFrameAPI-setTitle_String__table_kbl_w3y_kt}  

    openFrameAPI.setTitle('Incoming Call');

## openFrameAPI - setTitleIcon(icône d'objet) {#ariaid-title17}

Définit l'icône de titre d'OpenFrame.
{#r_openFrameAPI-setTitleIcon_Object__table_w42_kky_kt__entry__3}

| Nom | Type | Description |
|-|-|-|
| icône | Objet | Objet de paires de valeurs clés. Les clés incluent , imageTitle, imageURLet tout autre contexte nécessaire. Taille maximale : les icônes peuvent être un maximum de 16x16 pixels. Les images plus grandes sont automatiquement ajustées à ce maximum. |
[Tableau 31. Paramètres]

{#r_openFrameAPI-setTitleIcon_Object__table_w42_kky_kt} {#r_openFrameAPI-setTitleIcon_Object__table_x42_kky_kt__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 32. Renvoie]

{#r_openFrameAPI-setTitleIcon_Object__table_x42_kky_kt}  

    openFrameAPI.setTitleIcon({imageURL:'/my/image/path.png', imageTitle:'mute', id:101});

    openFrameAPI.setTitleIcon({imageURL:'https://mydomian.com/image/path.png',
    imageTitle:'mute', id:101});

## openFrameAPI - setWidth(largeur) {#ariaid-title18}

Définit la largeur de l'OpenFrame.
{#r_openFrameAPI-setWidth__table_yzb_mxx_kt__entry__3}

| Nom | Type | Description |
|-|-|-|
| Largeur | Numéro | Largeur en pixels |
[Tableau 33. Paramètres]

{#r_openFrameAPI-setWidth__table_yzb_mxx_kt} {#r_openFrameAPI-setWidth__table_zzb_mxx_kt__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 34. Renvoie]

{#r_openFrameAPI-setWidth__table_zzb_mxx_kt}  

    openFrameAPI.setWidth(100);

## openFrameAPI - show() {#ariaid-title19}

Rend l'OpenFrame visible dans le TopFrame.
{#r_openFrameAPI-show__table_ah2_vwx_kt__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 35. Paramètres]

{#r_openFrameAPI-show__table_ah2_vwx_kt} {#r_openFrameAPI-show__table_bh2_vwx_kt__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 36. Renvoie]

{#r_openFrameAPI-show__table_bh2_vwx_kt}  

    openFrameAPI.show()

## openFrameAPI - subscribe(événement openFrameAPIEVENT, fonction eventCallback) {#ariaid-title20}

S'abonne à un événement spécifié.
{#r_openFrameAPI-subscribe_Event_Object__table_znv_gvd_lt__entry__3}

| Nom | Type | Description |
|-|-|-|
| event | openFrameAPIEVENT | L'événement auquel s'abonner : * openframe_agent_off_interaction : indique la présence d'un agent sur le chat comme désactivée ou disponible. * openframe_awa_agent_presence : dans Affectation de travail avancée (AWA), cet événement se produit lorsqu'il y a un changement dans l'état de présence de l'agent. Les développeurs de couplage téléphonie-informatique (CTI) peuvent s'abonner à cet événement pour recevoir les changements d'état de présence. * openframe_awa_workitem_accepted : se produit lorsqu'un élément de travail est accepté par un agent. * openframe_awa_workitem_offered : se produit lorsqu'un élément de travail est proposé à un agent. * openframe_awa_workitem_rejected : se produit lorsqu'un élément de travail est rejeté par un agent. * openframe_before_destroy : se produit avant le déchargement du TopFrame. * openframe_collapse : se produit lorsque l'icône de réduction est sélectionnée dans l'en-tête OpenFrame. * openframe_communication : spécifique à l'application et peut être personnalisé. * openframe_communication_failure : se produit lorsque la communication vers TopFrame échoue. * openframe_expand : se produit lorsque l'icône de développement est sélectionnée dans l'en-tête OpenFrame. * openframe_header_icon_clicked : déconseillé. Utilisez openframe_icon_clicked ou openframe_title_icon_clicked à la place. * openframe_hidden : se produit lorsque la fenêtre OpenFrame est masquée. * openframe_icon_clicked : se produit lorsqu'une icône autre que l'icône de fermeture est sélectionnée dans le pied de page OpenFrame. Le rappel reçoit l'objet d'icône comme un paramètre. * openframe_shown : se produit lorsque la fenêtre OpenFrame est affichée. * openframe_title_icon_clicked : se produit lorsque l'icône de titre est sélectionnée sur OpenFrame. Le rappel reçoit l'objet d'icône de titre comme un paramètre. |
| eventCallback | function | Fonction à appeler lorsque l'événement spécifié se produit. |
[Tableau 37. Paramètres]

{#r_openFrameAPI-subscribe_Event_Object__table_znv_gvd_lt} {#r_openFrameAPI-subscribe_Event_Object__table_a4v_gvd_lt__entry__2}

| Type | Description |
|-|-|
| résultats | La plupart des abonnements à l'événement n'ont aucune valeur de retour. Les abonnements d'événements qui renvoient des valeurs sont décrits dans les entrées de table suivantes. |
| openframe_awa_agent_presence | Dans AWA, l'événement openframe_awa_agent_presence renvoie l'objet de `présence` : "presence":{ "available": Boolean, "channels":[ { "available": Boolean, "name": "String", "restrict_update": Boolean, "sys_id": "String" } ], "name": "String", "sys_id": "String" } presence : Informations sur la présence, l'état et le canal actuels d'un agent. * presence.available : Marqueur indiquant si l'agent est disponible. * presence.channels : Liste des objets qui décrivent les canaux de communication disponibles avec l'agent. * presence.channels.available : Marqueur indiquant si le canal est disponible. * presence.channels.name : Nom du canal, par exemple Messagerie instantanée ou Téléphone. * presence.channels.restrict_update : Marqueur indiquant si l'utilisateur peut restreindre les mises à jour. * presence.channels.sys_id : Canal sys_id. Situé dans la table Canaux de service \[awa_service_channel\]. {#r_openFrameAPI-subscribe_Event_Object__ul_xf1_pcp_zbc} * presence.name : Nom de l'état de présence de l'agent. * presence.sys_id : État de présence sys_id. Situé dans la table États de présence \[awa_presence_state\]. {#r_openFrameAPI-subscribe_Event_Object__ul_wf1_pcp_zbc} |
| openframe_awa_workitem_accepted et openframe_awa_workitem_offered | Dans AWA, les openframe_awa_workitem_accepted événements et openframe_awa_workitem_offered renvoient l'objet `workItem` : "workItem": { "document": { "sys_id": "String", "table": "String" }, "isQueueTransferred": Boolean, "previousWorkItem": "String", "serviceChannel": { "name": "String", "sys_id": "String" }, "size": Number, "sys_id": "String" } workItem: informations sur l'élément de travail associé à l'événement. * workItem.document: liste des documents associés à la tâche d'élément de travail. * workItem.document.sys_id: Sys_id du document affecté à la tâche d'élément de travail. * workItem.document.table: nom de la table de documents affectée à la tâche. {#r_openFrameAPI-subscribe_Event_Object__ul_svh_jww_zbc} * workItem.isQueueTransferred: indique si l'élément de travail est transféré dans la file d'attente. Défini sur vrai si l'élément de travail est transféré dans la file d'attente, sur faux s'il ne l'est pas. Pour plus d'informations sur les transferts de file d'attente, reportez-vous à la section [Transfer a chat to another queue](https://www.servicenow.com/docs/access?context=transfer-chat-queue&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US). * workItem.previousWorkItem: Sys_id de l'élément de travail précédent pour le même ID de document. Pour les éléments de travail sans transfert, cette valeur est vide. * workItem.serviceChannel: liste des canaux de service associés à la tâche d'élément de travail. * workItem.serviceChannel.name: nom du canal de service, par exemple Messagerie instantanée ou Téléphone. * workItem.serviceChannel.sys_id: Sys_id du canal de service. {#r_openFrameAPI-subscribe_Event_Object__ul_tvh_jww_zbc} * workItem.size: capacité de l'agent utilisée lorsque cet élément de travail est affecté à l'agent. * workItem.sys_id: Sys_id de l'élément de travail qui a été accepté ou proposé. {#r_openFrameAPI-subscribe_Event_Object__ul_rvh_jww_zbc} |
| openframe_awa_workitem_rejected | Dans AWA, l'événement openframe_awa_workitem_rejected renvoie l'objet `workItem` : "workItem": { "document": { "sys_id": "String", "table": "String" }, "isQueueTransferred": Boolean, "previousWorkItem": "String", "rejection": { "reason": "String", "sys_id": "String" }, "serviceChannel": { "name": "String", "sys_id": "String" }, "size": Number, "sys_id": "String" } workItem: informations sur l'élément de travail associé à l'événement. * workItem.document: liste des documents associés à la tâche d'élément de travail. * workItem.document.sys_id: Sys_id du document affecté à la tâche d'élément de travail. * workItem.document.table: nom de la table de documents affectée à la tâche. {#r_openFrameAPI-subscribe_Event_Object__ul_f3z_jww_zbc} * workItem.isQueueTransferred: indique si l'élément de travail est transféré dans la file d'attente. Défini sur vrai si l'élément de travail est transféré dans la file d'attente, sur faux s'il ne l'est pas. Pour plus d'informations sur les transferts de file d'attente, reportez-vous à la section [Transfer a chat to another queue](https://www.servicenow.com/docs/access?context=transfer-chat-queue&version=xanadu&pubname=xanadu-platform-user-interface&ft:locale=en-US). * workItem.previousWorkItem: Sys_id de l'élément de travail précédent pour le même ID de document. Pour les éléments de travail sans transfert, cette valeur est vide. * workItem.rejection: liste des raisons du rejet de l'élément de travail. * workItem.rejection.reason: nom du motif du rejet des éléments de travail. * workItem.rejection.sys_id: Sys_id du motif du rejet. Situé dans la table Raisons du rejet \[awa_reject_reason\]. {#r_openFrameAPI-subscribe_Event_Object__ul_g3z_jww_zbc} * workItem.serviceChannel: liste des canaux de service associés à la tâche d'élément de travail. * workItem.serviceChannel.name: nom du canal de service, par exemple Messagerie instantanée ou Téléphone. * workItem.serviceChannel.sys_id: Sys_id du canal de service. {#r_openFrameAPI-subscribe_Event_Object__ul_h3z_jww_zbc} * workItem.size: capacité de l'agent utilisée lorsque cet élément de travail est affecté à l'agent. * workItem.sys_id: Sys_id de l'élément de travail qui a été accepté ou proposé. {#r_openFrameAPI-subscribe_Event_Object__ul_e3z_jww_zbc} |
[Tableau 38. Renvoie]

{#r_openFrameAPI-subscribe_Event_Object__table_a4v_gvd_lt}  
L'exemple de code suivant montre comment appeler cette méthode pour un événement `openframe_awa_agent_presence` .

    function handleIconClick(context) {
    console.log("Icon was clicked", context);
    }
    openFrameAPI.subscribe(openFrameAPI.events.openframe_awa_agent_presence, handleIconClick);

Sortie :

    // Sample presence object output
    // openframe_awa_agent_presence event only

    {
      "result":{
        "presence":{
          "name":"Available",
          "sys_id":"27f675e3739713004a905ee515f6a7c3",
          "available":true,
          "channels":[
            {
              "name":"Chat",
              "available":true,
              "sys_id":"36f675e4239713124a905fe515f6a832",
              "restrict_update":false
            },
            {
              "name":"Phone",
              "available":true,
              "sys_id":"9378a530a1820610f809018efd9bc01e",
              "restrict_update":false
            }
          ]
        }
      }
    }

L'exemple de code suivant montre comment appeler cette méthode pour un événement `openframe_awa_workitem_accepted` .

    function handleIconClick(context) {
    console.log("Icon was clicked", context);
    }
    openFrameAPI.subscribe(openFrameAPI.events.openframe_awa_workitem_accepted, handleIconClick);

Sortie :

    // Sample workItem object output
    // openframe_awa_workitem_accepted event only
    {
      "result": {
        "workItem": {
          "sys_id": "14c86c40a1650610f87701807d9bc0be",
          "size": 1,
          "serviceChannel": {
            "name": "Chat",
            "sys_id": "27f675e3739713004a905ee515f6a7c3"
          },
          "document": {
            "sys_id": "aa582040a1650610f87701807d9bc076",
            "table": "interaction"
          },
          "previousWorkItem": "7c78a440a1650610f87701807d9bc02b",
          "isQueueTransferred": true
        }
      }
    }

L'exemple de code suivant montre comment appeler cette méthode pour un événement `openframe_awa_workitem_rejected` .

    function handleIconClick(context) {
    console.log("Icon was clicked", context);
    }
    openFrameAPI.subscribe(openFrameAPI.events.openframe_awa_workitem_rejected, handleIconClick);

Sortie :

    // Sample workItem object output
    // openframe_awa_workitem_rejected event only
    {
      "payload": {
        "workItem": {
          "sys_id": "2c3bdc4824250610f8775e73b116f8de",
          "size": "1",
          "serviceChannel": {
            "name": "Chat",
            "sysID": "27f675e3739713004a905ee515f6a7c3"
          },
          "document": {
            "sys_id": "cf0a180824250610f8775e73b116f80c",
            "table": "interaction"
          },
          "rejection": {
            "reason": "Busy",
            "sys_id": "4e93fa29b38023002e7b6e5f26a8dc20"
          },
          "previousWorkItem": "831b9c4824250610f8775e73b116f841",
          "isQueueTransferred": true
        }
      }
    }

## openFrameAPI - version() {#ariaid-title21}

Renvoie la version de l'API OpenFrame.
{#r_openFrameAPI-version__table_ob3_ryd_lt__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 39. Paramètres]

{#r_openFrameAPI-version__table_ob3_ryd_lt} {#r_openFrameAPI-version__table_pb3_ryd_lt__entry__2}

| Type | Description |
|-|-|
| Chaîne | La version de l'API OpenFrame |
[Tableau 40. Renvoie]

{#r_openFrameAPI-version__table_pb3_ryd_lt}  

    var version = openFrameAPI.version();

    console.log("API version " + version);