Altova MobileTogether Designer

mt-audio-get-current-position(ChannelNumber as xs:integer) asxs:decimal

Prend en tant que son argument le numéro de canal sur lequel le fichier audio cible est joué. Retourne un entier qui est la position actuelle de la lecture audio en secondes. Veuillez noter que les informations concernant la position actuelle ne seront disponibles qu'après le démarrage de la lecture, cette fonction ne devrait donc être utilisée qu'après le démarrage de lecture.

Utilisation

mt-audio-get-current-position(2)

mt-audio-get-duration(ChannelNumber as xs:integer) asxs:decimal

Prend en tant que son argument le numéro de canal sur lequel le fichier audio cible est joué. Retourne un entier qui est la durée du fichier audio actuel en secondes. Veuillez noter que les informations concernant la durée actuelle ne seront disponibles qu'après le démarrage de la lecture, cette fonction ne devrait donc être utilisée qu'après le démarrage de lecture.

Utilisation

mt-audio-get-duration(5)

mt-audio-is-playing(ChannelNumber as xs:integer) asxs:boolean

Prend en tant que son argument le numéro de canal sur lequel le fichier audio cible est joué. Retourne true()si l'appareil client joue un fichier audio, sinon false().

Utilisation

mt-audio-is-playing(3)

Description

Retourne true()si l'appareil client enregistre en audio, false() dans le cas contraire.

Utilisation

mt-audio-is-recording()

mt-available-db-connection-names(FromSolution as xs:boolean) asxs:string

Retourne les noms de toutes les connexions de base de données (BD) disponibles. Si FromSolution est défini sur true(), il retourne les noms des connexions BD dans la solution. Si FromSolution est défini sur false(), il retourne les noms des connexions BD enregistrées sur le serveur. L'objet retourné est une séquence de strings.

Exemples

Description

Retourne les langages qui ont été définis dans le dialogue de localisation.

Dans le dialogue Localisation, chaque langue est spécifiée par son code de langue ISO (par exemple : en-US) et par un nom donné (par exemple : English). Le code de langue de la langue par défaut est toujours le string vide, mais le nom peut être n'importe quel string.

La fonction retourne chaque langue en tant qu'un tableau de deux strings ; par exemple : [ "en-US", "English" ]. Plusieurs langues sont retournées en tant qu'une séquence d'items d'array ; par exemple : ( ["en-US", "English"], ["de-DE", "German (DE)"] ). Le premier array dans la séquence retournera toujours la langue par défaut du design. Donc, si aucun nom de langue n'est spécifié pour la langue par défaut (dans le dialogue Localization), les deux strings du premier item d'array seront vides ; sinon, le premier item d'array contiendra un string vide et le nom qu'il aura reçu pour la langue par défaut (par exemple : [ "", "MyDefaultLanguage" ]).

Veuillez noter que la séquence retournée sera affichée en tant que strings séparés par des espaces.

Utilisation

mt-available-languages()pourrait retourner une valeur d'affichage de :  en-US English

mt-available-languages()pourrait retourner une valeur d'affichage de :  en-US English de-DE German (DE)

mt-available-languages()pourrait retourner une valeur d'affichage de : MyDefaultLanguage en-US English

mt-base64-to-hexBinary(Base64Image as xs:base64Binary) asxs:string

La fonction convertit une image encodée en Base64 en un string hexBinary. L'argument Base64Image doit être un texte qui est encodé en base64Binary. Un nœud de source de page qui fournit ce type de texte peut être soumis.

Utilisation

mt-base64-to-hexBinary($XML1/Element1/@image) convertit une image en Base64 en hexBinay

Description

Retourne true() si Bluetooth a été démarré sur l'appareil et la solution a accès à Bluetooth, false() si la solution n'a pas accès à Bluetooth.

Utilisation

mt-bluetooth-started()

Description

Retourne l'heure à laquelle le cache de source de page a été mis à jour. Si la source de page n'est pas mise en cache, une séquence vide est retournée.

Utilisation

mt-cache-update-dateTime($XML1)

mt-called-by-enter-key() as xs:boolean

Retourne true() si la pile d'actions actuelle a été déclenchée en appuyant sur la touche Entrée, false() dans le cas contraire. Le fait de savoir que l'utilisateur a appuyé sur la touche Entrée pour démarrer la pile d'actions actuelle, par opposition par exemple à la touche Esc, indiquerait l'intention de l'utilisateur, ce qui permettrait, le traitement conditionnel dans le cadre de la pile d'action.

mt-called-by-escape-key() as xs:boolean

Retourne true() si la pile d'actions actuelle a été déclenchée lorsque l'utilisateur appuie sur la touche Esc, false() dans le cas contraire. Le fait de savoir que l'utilisateur a appuyé sur la touche Esc indiquerait une intention différente de si l'utilisateur avait appuyé sur la touche Entrée, permettant ainsi de traiter la condition dans le cadre de la pile d'actions.

mt-change-image-colors(Base64Image as xs:base64Binary, SourceColors as xs:string+, TargetColors as xs:string+, Quality as xs:integer) asxs:base64Binary

La fonction prend une image encodée Base64 en tant que son premier argument, change les couleurs d'image qui sont soumises en tant que l'argument SourceColors dans les TargetColors correspondant et retourne l'image transformée en tant qu'image encodée Base64.

•Base64Image doit être encodé en texte en base64Binary. Un nœud qui retourne un tel texte peut être soumis.

•SourceColors et TargetColors doivent être des séquences avec un ou plusieurs items de chaîne. Le nombre d'items dans les deux séquences doit être le même.

•La qualité est un entier de 1 à 100. Elle spécifie le niveau de qualité, 100 représentant la qualité la plus élevée.

Exemples

mt-client-ip-address() comme xs:string

Si une en-tête HTTP, telle que Remote_Addr ou X-Forwarded-For, est utilisée pour faire la requête HTTP vers MobileTogether Server, puis mt-client-ip-address() renvoie la valeur de l’en-tête. Obtenir une valeur de l’en-tête est utile quand la solution sur un MobileTogether Server est derrière un serveur proxy ou reverse proxy.

Si aucune en-tête HTTP pertinente n’est présente, alors la fonction renvoie l’adresse IP du client tel que vu par le serveur.

Pour les simulations, définir une adresse IP dans l’onglet Simulation du dialogue des Options (Outils | Options) de MobileTogether Designer.

Exemple

mt-client-theme() as (xs:string, xs:string)

Retourne une séquence de deux strings. Le premier string est le thème qui est actuellement utilisé par la solution ; ce string peut avoir une valeur de clair ou sombre. Le deuxième string est le paramètre du thème de la solution (qui est défini dans les propriétés de projet) ; il peut avoir la valeur de clair, sombre, ou par défaut.

Exemple

Description

Retourne true() si l'appareil mobile est connecté par LAN, false() dans le cas contraire.

Utilisation

mt-connected-via-lan()

Description

Retourne true() si l'appareil mobile est connecté par WiFi, false() dans le cas contraire.

Utilisation

mt-connected-via-wifi()

mt-control-text-offset(ControlKind as xs:string) as xs:integer*

mt-control-text-offset(ControlKind as xs:string, Parameters as map) as xs:integer*

Retourne la valeur de pixel des retraits gauche, haut, droite et bas, dans cet ordre, du contenu de la commande nommée dans l'argument ControlKind. Le second argument, Parameters, est optionnel et est un map key-value qui définit les propriétés de la commande. Les clés disponibles et leurs valeurs sont énumérées ci-dessous. Le map filtre le type de commande nommé dans ControlKind dans les instances du type de commande qui correspond aux valeurs de propriété recensées dans le map.

Les valeurs de retour de cette fonction peuvent être utilisées pour aligner le contenu des commandes sélectionnées. Voir exemple ci-dessous.

Ci-dessous, vous trouverez les paires key-value disponibles pouvant être soumises en tant que le map de l'argument Parameters. L'ordre des paires clé-valeurs dans le map n'est pas fixé.

•"Text Size" : "small"|"medium"|"large"

•"Unit" : "px"|"dp"|"sp"|"" défaut est "px". Pour plus d'informations concernant les relations entre les pixels, dp (pixels indépendants de l'appareil), et sp (pixels indépendant de l'échelle), voir Tailles : Pixels, DPI, DP, SP.

•"Bold Text" : "true"|"false"

•"Italic Text" : "true"|"false"

•"Underline Text" : "true"|"false"

•"Button Image" : Une des options Button Image (par exemple, "+"|"-"|">"|"Share")

•"Button Background" : "transparent"|"non-transparent". Défaut est "non-transparent".

Exemple

mt-control-width(Text as xs:string*, Parameters as map(*)) as xs:integer?

Retourne la largeur minimum en pixels de la commande lorsque la chaîne Text est le texte d'affichage de la commande. L'argument Text est le texte affiché dans la commande. L’argument Parameters est un map key-value qui définit les propriétés de la commande. Les clés disponibles et leurs valeurs sont regroupées ci-dessous. L’entier qui est retourné est la largeur minimum, en pixels, de la commande lorsque le string Text soumis est affiché avec les propriétés spécifiées dans l’argument Paramètres. Cette valeur peut ensuite être utilisée pour calculer et spécifier d’autres propriétés liées à la commande, comme les largeurs des colonnes de table dans laquelle la commande apparaît.

Note : Cette fonction n'est pas disponible pour le rendu de client web. Pour un rendu de client web, utiliser l'action Commandes de mesure action.

Note :  Cette fonction peut uniquement être utilisée dans les expressions XPath des (i) actions de design et (ii) l'option S'assurer de l'existence lors du chargement(Valeur XPath) des nœuds d'arborescence de source de page. Elle n'est pas autorisée dans les expressions XPath des propriétés de style.

Ci-dessous, vous trouverez les paires key-value disponibles pouvant être soumises en tant que mappage de l'argument Parameters. L'ordre des paires key-value dans le map n'est pas fixé. Si une propriété de commande, telle que spécifiée par une paire de clé-valeur n'est pas soumise, alors cette valeur par défaut de la propriété (respectivement pour la commande Libellé ou Bouton) est utilisée. Par conséquent, seul le paramètre Type de commande est obligatoire.

•"Control Kind" : "Label"|"Button"

•"Text Size" : "small"|"medium"|"large"

•"Unit" : "px"|"dp"|"sp"|"" le défaut est "px". Pour plus d’informations concernant les relations entre les pixels, dp (pixels dépendant des appareils), et sp (pixels indépendants de l’échelle), voir Tailles : Pixels, DPI, DP, SP.

•"Bold Text" : "true"|"false"

•"Italic Text" : "true"|"false"

•"Underline Text" : "true"|"false"

•"Button Look" : Une des options Image de bouton (par exemple, "+"|"-"|">"|"Share")

•"Arrière-plan de la touche" : "transparent"|"non-transparent". Le défaut est "non-transparent".

Exemples

mt-convert-units(Size as xs:string, TargetUnit as xs:string) as xs:string

Convertit la valeur de longueur spécifiée dans l’argument Taille en une valeur équivalente dans l’unité spécifiée par l’argument TargetUnit. Vous pouvez convertir entre deux des unités suivantes : px, dp et sp. Les deux arguments d’entrée, ainsi que la valeur de sortie, sont des strings. Pour plus d’information concernant les unités et la conversion entre elles, voir Tailles : Pixels, DPI, DP, SP.

Exemples

Description

Retourne true si l'élément de ligne contient des colonnes nouvelles, modifiées ou supprimées. Retourne false si les champs ne sont pas modifiés. La fonction teste s'il y a eu des modifications à la ligne de BD spécifiée. Note : Pour que cette fonction fonctionne correctement, l’élément OriginalRowSet doit être activé sur la source de page BD.

Utilisation

mt-db-any-changed-fields($DB1/DB/RowSet/Row[3])

Description

Retourne true si la variable $DB (qui représente une source BD) contient des lignes nouvelles, modifiées ou supprimées. Retourne false si la BD n’a pas été modifiée. La fonction teste s'il y a eu des modifications à la BD, et fonctionne aussi si l’élément RowSets n’a pas de clé primaire. Note : Pour que cette fonction fonctionne correctement, l’élément OriginalRowSet doit être activé sur la source de page BD.

Utilisation

mt-db-any-changed-rows($DB1)

Description

Prend une ligne RowSet comme son entrée et renvoie les attributs de champ depuis l’élément original Row :

•Pour des nouvelles lignes : la fonction retourne aucun attribut de champ. Si la fonction est appelée pour une nouvelle ligne, elle retourne une liste vide.

•Pour les lignes modifiées : la fonction retourne les attributs de champs supprimés. Si la fonction est appelée pour une ligne modifiée, elle retourne ces champs depuis la ligne d’origine correspondante qui ne sont pas listés dans l’élément RowSet.

•Pour des lignes originales supprimées : la fonction retourne tous les attributs de champ. Si la fonction est appelée pour une ligne qui est supprimée dans RowSet, elle retourne les champs de la ligne originale supprimée.

Note : Pour que cette fonction fonctionne correctement, l’élément OriginalRowSet doit être activé sur la source de page BD.

Utilisation

mt-db-deleted-original-fields($DB1/DB/RowSet/Row[1])

Description

Retourne tous les éléments OriginalRow pour lesquels aucun élément Row n'existe. La fonction peut être utilisée pour déterminer les modifications aux données lues depuis la base de données. Note : Pour que cette fonction fonctionne correctement, l’élément OriginalRowSet doit être activé sur la source de page BD.

Utilisation

mt-db-deleted-original-rows($DB1)

Description

Prend une source de page (variable) en tant que son paramètre unique et retourne le chemin du fichier de la base de donnée basée sur fichier de la source de page. Le chemin du fichier sera relatif au Répertoire de travail des solutions.

Note

•Il s'agit d'une fonction de côté serveur et qui peut uniquement être effectuée sur le serveur.

•La fonction marche pour les bases de données SQLite et Access.

Utilisation

mt-db-file-path($DB1)

Description

Prend une ligne RowSet comme son entrée et renvoie les attributs de champ modifiés depuis l’élément Row spécifié :

•Pour les nouvelles lignes : tous les attributs de champ. Si la fonction est appelée pour une nouvelle ligne, elle retourne tous les champs.

•Pour les lignes originales supprimées : tous les attributs de champ. Si la fonction est appelée pour un OriginalRow (une ligne pour laquelle l'élément Row correspondant a été supprimé), elle retourne tous les champs.

•Pour les lignes modifiées : les attributs de champ modifiés. Si la fonction est appelée pour une ligne modifiée, elle retourne les champs qui ont une valeur différente de celle stockée dans l'élément OriginalRow correspondant.

Note : Pour que cette fonction fonctionne correctement, l’élément OriginalRowSet doit être activé sur la source de page BD.

Utilisation

mt-db-modified-fields($DB1/DB/RowSet/Row[3])

Description

Prend une source BD comme son entrée et retourne une séquence d’éléments Ligne modifiés, c’est-à-dire chaque élément Ligne qui est différent sous l’élément RowSet que la ligne correspondante dans l’élément OriginalRowSet. La fonction peut être utilisée pour déterminer les modifications aux données de ligne actuelles en comparaison aux données de ligne originales lues depuis la BD. Note : Pour que cette fonction fonctionne correctement, l’élément OriginalRowSet doit être activé sur la source de page BD.

Notez que pour cette fonction les lignes sont identifiées par leurs premières clés. Cette fonction ne vérifie que si le contenu de la ligne a changé. Pour rechercher de nouvelles lignes, utilisez la fonction mt-db-new-rows. Pour rechercher des lignes supprimées, utilisez la fonction mt-db-deleted-original-rows. Un réarrangement des lignes n’est pas considéré être une modification.

Utilisation

mt-db-modified-rows($DB1)

Description

Prend une ligne RowSet comme son entrée et renvoie les nouveaux attributs de champ depuis l’élément Row spécifié :

•Pour les nouvelles lignes : tous les attributs de champ. Si la fonction est appelée pour une nouvelle ligne, elle retourne tous les champs.

•Pour les lignes modifiées : les nouveaux attributs de champ. Si la fonction est appelée pour une ligne modifiée, elle retourne ces champs ligne d’origine qui ne sont pas listés dans l’élément correspondant RowSet.

•Pour les lignes originales : toute liste vide. Si la fonction est appelée pour un élément OriginalRow (une ligne pour laquelle l'élément Row correspondant a été supprimé), elle retourne toute liste vide.

Note : Pour que cette fonction fonctionne correctement, l’élément OriginalRowSet doit être activé sur la source de page BD.

Utilisation

mt-db- new-fields($DB1/DB/RowSet/Row[1])

Description

Prend une source BD comme son entrée et retourne une liste de nouveaux éléments Ligne, c’est-à-dire les éléments Ligne qui sont listés sous l’élément RowSet mais pas sous l’élément OriginalRowSet. La fonction peut être utilisée pour déterminer les modifications des données lues depuis la BD. Note : Pour que cette fonction fonctionne correctement, l’élément OriginalRowSet doit être activé sur la source de page BD.

Utilisation

mt-db-new-rows($DB1)

Description

Afin d’activer l’édition des lignes de BD, une copie de la ligne originale est enregistrée dans une source de page de BD dans un élément nommé OriginalRowSet, tandis que les modifications sont stockées dans une structure de données parallèle appelée RowSet. En enregistrant la source de page, le contenu de RowSet est copié dans OriginalRowSet.

La fonction mt-db-original-row prend une ligne de la structure de donnéesRowSet et renvoie la ligne correspondante depuis l’arborescence originale. Cette fonction est l’inverse de la fonction mt-db-row-from-original. Pour plus d’information, voir les sections Éditer données BD et Enregistrer les données à la BD.

Note : Pour que cette fonction fonctionne correctement, l’élément OriginalRowSet doit être activé sur la source de page BD.

Utilisation

mt-db-original-row($DB1/DB/RowSet/Row[1]) renvoie $DB1/DB/OriginalRowSet/Row[1].

Description

Afin d’activer l’édition des lignes de BD, une copie de la ligne originale est enregistrée dans une source de page de BD dans un élément nommé OriginalRowSet, tandis que les modifications sont stockées dans une structure de données parallèle appelée RowSet. En enregistrant la source de page, le contenu de RowSet est copié dans OriginalRowSet.

La fonction mt-db-row-from-original prend une ligne depuis l’arborescence originale et renvoie la ligne correspondante dans la structure de données RowSet. Cette fonction est l’inverse de la fonction mt-db-original-row. Pour plus d’information, voir les sections Éditer données BD et Enregistrer les données à la BD.

Note : Pour que cette fonction fonctionne correctement, l’élément OriginalRowSet doit être activé sur la source de page BD.

Utilisation

mt-db-row-from-original($DB1/DB/OriginalRowSet/Row[1]) retourne $DB1/DB/RowSet/Row[1].

mt-email-attachment(Filename as xs:string, Content as item(), ContentType as xs:string) asarray(*)

Prépare le contenu XML, Base64 ou texte qui est fourni par l'argument Content sous forme d'une pièce jointe d'e-mail. Que l'argument ContentType soit parsé en tant qu'XML ou Base64 ou texte est déterminé par l'argument ContentType qui prend soit XML, Base64 ou texte en tant que sa valeur. Le nom de fichier associé avec la pièce jointe est donné par l'argument Filename.

Note : mt-email-attachment est une exigence pour l'utilisation de l'option Pièce jointe dynamique des actions Envoyer e-mail à et Share.

Note :  Pour les e-mails qui sont envoyés en tant que HTML, le corps de l'e-mail doit être un HTML correct, c'est à dire qu'il doit commencer avec l'élément html. Un corps valide peut être créé par exemple avec la construction XPath/XQuery suivante : element html { element body { "Test" } }

Note :  Les pièces jointes fonctionnent uniquement avec les clients Android et iOS.

Exemples

Description

Retourne le code d'erreur de la dernière action BD, Charger ou Enregistrer. Retourne le code d'erreur natif du SE ou de la base de données avec 404 comme lorsqu'une page web ne peut pas être trouvée.

Utilisation

mt-external-error-code()

Description

Retourne le texte d'erreur de la dernière action BD ou l'action de charger/enregistrer. Le texte d'erreur est le texte qui est fourni avec le code d'erreur retourné.

Utilisation

mt-external-error-text()

mt-extract-file-extension(FilePath as xs:string) asxs:string?

Retourne l'extension de fichier (par exemple, xml) du fichier dans le chemin d'accès soumis en tant que l'argument FilePath. La chaîne soumise dans l'argument FilePath doit avoir le motif lexical d'un chemin d'accès absolu ou relatif. Veuillez noter que vous pouvez utiliser la fonction mt-last-file-path en tant que l'argument FilePath.

Exemples

mt-extract-file-name(FilePath as xs:string) asxs:string?

Retourne le nom de fichier (la partie avant l'extension de type de fichier) du fichier dans le chemin d'accès soumis en tant que l'argument FilePath. La chaîne soumise dans l'argument FilePath doit avoir le motif lexical d'un chemin d'accès absolu ou relatif. Veuillez noter que vous pouvez utiliser la fonction mt-last-file-path en tant que l'argument FilePath.

Exemples

mt-font-height(TextSize as xs:string*, Unit as xs:string) asxs:string?

Retourne la hauteur en pixels de la taille des mots qui est soumise en tant que l'argument TextSize. Les valeurs autorisées pour l'argument TextSize sont : smallest|small|medium|large|largest. L'argument Unit optionnel spécifie les unités dans lesquelles la hauteur numérique retournée est exigée ; actuellement, seules les hauteurs de pixel sont retournées.

Chaque plate-forme/appareil a sa propre hauteur de pixel pour chaque size-in-words. C'est pourquoi la fonction mt-font-height vous permet d'obtenir les valeurs numériques qui correspondent à chaque size-in-words de l'appareil puis de calculer une autre valeur numérique. Par exemple, pour obtenir une taille 120 % plus grande que la taille numérique qui correspond à 'largest' sur un appareil, vous devrez utiliser l'expression XPath : mt-font-height('largest', 'px') * 1.2. La fonction génère la valeur numérique (pixel) qui correspond à la taille 'largest'. Cette valeur est ensuite multipliée par 1.2 pour obtenir la valeur numérique de 120 % de la valeur qui correspond à 'largest'.

Note :  Cette fonction peut uniquement être utilisée dans les expressions XPath des (i) actions de design et (ii) l'option S'assurer de l'existence lors du chargement(Valeur XPath) des nœuds d'arborescence de source de page. Elle n'est pas autorisée dans les expressions XPath des propriétés de style.

Exemples

mt-format-number(Number as xs:numeric, PictureString as xs:string) asxs:string

Prend en nombre en tant que premier argument, le format conformément au second argument (PictureString), et retourne le numéro formaté en tant que string. Cela est utile pour le formatage de nombres difficiles à lire dans un format plus agréable à la lecture. Le string d'image peut aussi contenir des caractères comme des symboles de devise et peuvent donc être utilisés pour insérer des caractères dans la sortie formatée. Si vous souhaitez insérer un zéro dans une position de chiffre où aucun chiffre n'existe dans le nombre d'entrée à cette position, utilisez un zéro dans cette position de chiffre du string d'image (voir exemples ci-dessous). Si vous ne souhaitez pas forcer un zéro (ou d'autres caractères), utilisez le symbole dièse (#).

Les chiffres devant le séparateur décimal ne sont jamais tronqués. La partie décimale d'un nombre (à droite du séparateur décimal) et les chiffres des unités (premier chiffre à gauche du séparateur décimal) sont arrondis si le string d'image de la partie décimale est plus court que le nombre de places décimales dans le nombre d'entrée.

Note : Le séparateur de groupement et le séparateur décimal de la sortie formatée dans l'appareil mobile seront ceux de la langue utilisée dans l'appareil mobile.

Exemples

mt-geo-map-marker(id as xs:string, geolocation as xs:string) asmap (*)

mt-geo-map-marker(id as xs:string, geolocation as xs:string, popup? as (xs:string*)) asmap (*)

mt-geo-map-marker(id as xs:string, geolocation as xs:string, popup? as (xs:string*), color? as xs:string) asmap (*)

La fonction génère un map-construct* XPath, qui est utilisé pour créer un marqueur pour la commande Carte de géolocalisation. Les arguments id et geolocation de la fonction sont obligatoires ; les arguments popup et color sont optionnels. Chacun des strings soumis est retourné en tant que texte dans une valeur d'une des paires key–value du map-construct (voir les exemples ci-dessous). Chaque clé du map-construct retourné obtient receives sa valeur depuis l'argument correspondant de la fonction, ces correspondances sont déterminées par le numéro d'index de l'argument. Par exemple, le premier argument de la fonction fournit la valeur de la clé id. Veuillez noter que le troisième argument de la fonction est une séquence de strings. Ces strings sont utilisés pour générer le titre et le texte du popup du marqueur. Le premier string apporte le titre du popup ; les strings suivants sont concaténés pour fournir le texte du popup, chaque string commençant une nouvelle ligne. Si vous ne souhaitez pas qu'un popup soit créé, veuillez soumettre une séquence vide en tant que le troisième argument. L'argument color peut être donné en tant que texte (par exemple, "green") ou en tant que valeur RGB (par exemple, "#336699"). Si aucun argument color n'est spécifié, la couleur de marqueur par défaut de l'appareil sera utilsée.

Veuillez noter que chaque fonction retourne un marqueur. Pour générer plusieurs marqueurs, utiliser une séquence de plusieurs fonctions mt-geo-map-marker. Voir les exemples ci-dessous. Veuillez aussi noter que vous pouvez utiliser la fonction mt-geo-map-marker dans le cadre des expressions XPath comme affiché dans le troisième exemple ci-dessous (qui utilise une construction if-then-else).

* map-construct XPath : Une construction de type de données XPath semblable à un array XPath. Le map-construct est une séquence de paires de key–value (voir le map exemple qui est retourné dans le premier exemple de la section Utilisation ci-dessous). Veuillez noter que la sémantique de "map" dans "XPath map-construct" réfère à un mappage de clés vers des valeurs dans XPath ; il ne fait pas référence à un plan cartographique.

Utilisation

mt-geo-map-marker("vie","48.2143531 16.3707266", ("Vienna","Altova EU","European headquarters"), "green") retourne une seule construction de carte XPath ; génère un seul marqueur dans la commande Carte de géolocalisation :

map {

    "id":"vie",

    "geolocation":(48.2143531, 16.3707266),

    "title":"Vienna",

    "text":"Altova EU

            European headquarters",

    "color":"green"

}

mt-geo-map-marker("vie","48.2143531 16.3707266", ("Vienna","Altova EU")), mt-geo-map-marker("bev","42.5584577 -70.8893334", ("Beverly","Altova US")) retourne deux constructions de carte XPath (et donc deux marqueurs pour la commande de Carte de géolocation).

mt-geo-map-marker("vie","48.2143531 16.3707266", ("Vienna","Altova EU")),

mt-geo-map-marker("bev","42.5584577 -70.8893334",("Beverly","Altova US")),

if ( $XML/MapMarkers/@withLondon = "1" ) then

 mt-geo-map-marker("lon","51.50939 -0.11832", ("London","No Altova") )

else

 ()

retourne deux constructions de carte XPath, plus, si l'attribut @withLondon a une valeur de "1", une troisième construction de carte XPath pour la géolocalisation pour Londres ; la fonction génère donc deux ou trois marqueurs pour la commande de Carte de géolocalisation.

Description

Retourne true() si la solution a lancé le suivi de géolocalisation, false() sinon.

Utilisation

mt-geolocation-started()

mt-get-page-source-from-name(PageSourceName en tant que string) as node

Retourne l'élément de racine de la source de page qui contient un nom qui correspond au string soumis. Par conséquent, vous pouvez accéder à des nœuds du document entier via XPath. Si aucune source de page de la page actuelle a un nom qui correspond au string soumis, une erreur sera lancée. L’argument de string soumis ne nécessite pas d’inclure le caractère de début $.

Utilisation

mt-get-page-source-from-name("$PERSISTENT") retourne l'élément racine de la source de page $PERSISTENT, par exemple $PERSISTENT/Orders

mt-get-page-source-from-name("PERSISTENT") retourne l'élément racine de la source de page $PERSISTENT, par exemple $PERSISTENT/MyRootElement

mt-get-page-source- name(PageSource as node()) as xs:string

Retourne le nom de la source de page qui est soumise avec l'argument PageSource. Le nom est retourné en tant que string.

Utilisation

mt-get-page-source-name($XML1) retourne le string "$XML1"

mt-get-page-source-name($PERSISTENT) retourne le string "$PERSISTENT"

mt-get-page-source-structure(PageSource comme nœud() ou comme xs:string) comme xs:string

mt-get-page-source-structure(PageSource comme nœud() ou comme xs:string, EnsureValues comme booléen) comme xs:string

mt-get-page-source-structure(PageSource comme nœud() ou comme xs:string, EnsureValues comme booléen, Chemin comme xs:string) comme xs:string

Retourne la structure de la source de page qui est soumise avec l'argument PageSource. Si l'argument EnsureValues est défini sur true(), alors, le contenu des nœuds est aussi retourné. Si EnsureValues est défini sur false(), ou si aucun second argument est fourni (voir la première signature ci-dessus), ensuite la structure de source de page est retournée sans contenu. La structure et le contenu sont ceux au moment où la source de page est chargée.

Un troisième argument (Chemin) peut être spécifié comme string si vous souhaitez sélectionner une sous-structure particulière de l’arborescence retournée par le premier paramètre, PageSource. Le string sera évalué comme expression localisatrice XPath au sein du contexte du nœud retourné par PageSource. Si le nœud retourné par cette expression est un élément, alors l’élément sera retourné avec ses attributs mais sans élément enfant.

Utilisation

mt-get-page-source-structure($XML1) retourne la structure de données de la source de page $XML1 quand la source de page sera chargé mais sans valeurs

mt-get-page-source-structure($XML1, true()) retourne la structure de données de la source de page $XML1 avec des valeurs

mt-get-page-source-structure($XML1/Companies/Company, false(), "Departments/Department) retourne l’élément Département avec ses attributs, mais sans valeurs.

for $i in mt-get-page-source-structure($XML1, true()) return $i//Product[1] retourne le contenu du premier élément Product de la source de page $XML1 au moment où la source de page a été chargée

Description

Retourne true si l'accès serveur est possible, sinon false. Il existe deux signatures :

•mt-has-serveraccess(TimeoutSeconds comme integer): La fonction contrôle si une connexion à MobileTogether Server peut être établie dans le cadre du nombre de secondes spécifiées par l'argument TimeoutSeconds de la fonction.

•mt-has-serveraccess(URL comme string, TimeoutSeconds comme integer): Vérifie si une connexion au serveur situé dans l’argument URL peut être établie au sein du nombre de secondes spécifiées par l’argument TimeoutSeconds de la fonction. De manière essentielle, une requête GET au serveur URL est réalisée avec un timeout.

Utilisation

mt-has-serveraccess(5)

mt-has-serveraccess('https://www.altova.com', 5)

mt-hexBinary-to-base64(HexBinary as xs:string) asxs:base64Binary

La fonction convertit un string hexBinary en un string encodé en Base64 (généralement une image). Un nœud qui fournit le string hexBinary requis peut être soumis en tant que l'argument HexBinary.

Utilisation

mt-hexBinary-to-base64('48656C6C6F20576F726C64') retourne le string Base64 'SGVsbG8gV29ybGQ='

mt-hexBinary-to-string(HexBinary as xs:string, Encoding comme xs:string) as xs:string

mt-hexBinary-to-string(HexBinary comme xs:string) comme xs:string

La fonction convertit un string hexBinary au prochain string de texte encodé avec l’encodage nommé dans l’argument Encodage. Un nœud qui fournit un string hexBinary peut être soumis comme argument HexBinary. Si le string vide est fourni comme argument Encodage ou si aucun argument Encodage n’est spécifié, alors le string de texte de résultat est généré dans l’encodage par défaut 'UTF-8'.

Exemples

Description

La fonction mt-html-anchor prend deux arguments : LinkText et TargetURL. Elle utilise ces deux arguments pour créer un élément hyperlien HTML : <a href="TargetURL">LinkText</a>. Le lien peut être inséré dans des e-mails envoyés en HTML en utilisant l'action Envoyer e-mail à. Le lien peut ouvrir une page Internet ou une solution MobileTogether. Pour ajouter un lien au corps de l'e-mail, utiliser la fonction mt-html-anchor dans l'expression XPath de l'option Corps (voir capture d'écran ci-dessous).

Exemples

mt-image-width-and-height(Image as base64encoded-image) asxs:integer+

L'argument Image est l'encodage Base64 de l'image, dont vous connaissez les dimensions. L'argument doit être de type xs:base64Binary. Généralement, l'argument localise un nœud qui co n tient des données encodées en Base64. La fonction retourne une séquence de deux entiers : (i) la largeur, (ii) la hauteur.

Exemples

mt-in-app-purchase-platform-to-product(PlatformID as xs:string) as xs:string

L'argument PlatformID est l'ID d'un produit sur une plateforme donnée. Il retourne le nom de produit qui mappe l'ID de ce produit, tel que défini dans le dialogue des produits d'achat In-App. Voir également la fonction mt-in-app-purchase-product-to-platform().

Exemples

mt-in-app-purchase-product-to-platform(ProductName as xs:string) as xs:string

L'argument ProductName est le nom d'un produit tel que défini dans le dialogue des produits d'achat In-App. Il retourne l'ID du produit sur la plateforme actuelle conformément au dialogue des produits d'achat In-App. Voir également la fonction mt-in-app-purchase-platform-to-product().

Exemples

mt-in-app-purchase-service-started() as xs:boolean

Vérifie si l'appareil client est doté de toutes les exigences nécessaires pour effectuer des achats in-app dans son app store respectif, y compris un service de facturation en cours. Par exemple, sur Android, un compte utilisateur pour l'app store est requis pour effectuer un achat in-app. La fonction retourne true()si le service est disponible, et false()s'il ne l'est pas.

Exemples

mt-invert-color(Color as xs:string) asxs:string

L'argument Couleur est le code couleur RGB (en format hexadécimal). Par exemple, "#00FFFF". Chaque composant de couleur (R, G, et B) dans le code est inversé, et le nouveau code de couleur est retourné.

Exemples

Description

Retourne true si toutes les licences attribuées à MobileTogether Server sont des licences achetées, false si une ou plusieurs licences attribuées sont des licences d'essai. Astuce : si une licence d'essai n'est plus nécessaire, il faut la désattribuer.

Veuillez noter :

•Sur les clients la fonction retourne false par défaut. Ce n'est que lorsqu'une requête est effectuée dans un serveur que l'état-d'achat des licences du serveur sera retourné.

•Dans le simulateur, la fonction retourne false. Utiliser l'option de simulateur correspondant pour simuler une licence achetée. Pour consulter des simulations dans le designer et pour des marches d'essai dans le client, il faut allumer cette option pour simuler l'achat de licences MobileTogether Server. Pour consulter des simulations sur le serveur, l'état-d'achat réel des licences du serveur sera retourné.

Utilisation

mt-is-server-purchased()

mt-last-file-path() asxs:string?

Retourne le chemin d'accès complet du fichier (par exemple, sur Android : /storage/emulated/0/Download/MyFile.xml) du dernier fichier client utilisé (chargé ou enregistré) dans une des actions suivantes: Enregistrement audio, Enregistrement vidéo, Charger/Enregistrer fichier, Charger/Enregistrer fichier Binaire, Charger images. Veuillez noter que certaines versions des systèmes d'exploitation autres qu'Android peuvent ne pas prendre en charge cette fonction.

Utilisation

mt-last-file-path()

mt-last-in-app-purchase-response-code() as xs:integer

Retourne le code de succès/d'échec de la dernière requête d'achat in-app effectuée par l'appareil client dans l'app store. Si la requête a été exécutée avec succès, le code est généralement 0, autrement, il renverrait un autre entier. La fonction est utile pour vérifier si une étape du flux de travail a été exécutée correctement. Les fonctions y afférentes sont mt-in-app-purchase-response-text() et mt-in-app-purchase-response-was-user-canceled().

Exemples

mt-last-in-app-purchase-response-text() as xs:string

Retourne un message texte décrivant le succès/l'échec de la dernière requête d'achat in-app. La fonction est particulièrement utile s'il y a une erreur parce qu'elle fournit une description textuelle de l'erreur. Les fonctions y afférentes sont mt-in-app-purchase-response-was-user-canceled() et mt-in-app-purchase-response-code().

Exemples

mt-last-in-app-purchase-response-was-user-canceled() as xs:boolean

Vérifie avec l'app store si le dernier achat in-app a été annulé par l'utilisateur. Il retourne true()si le dernier achat a été annulé, autrement false(). Les fonctions y afférentes sont mt-in-app-purchase-response-text() et mt-in-app-purchase-response-code(). Cette fonction est utile en ce sens qu'elle fait la distinction entre ce genre de requête d'achat échouée et d'autres types d'erreurs qui pourraient apparaître pendant la requête d'achat.

Exemples

Description

La fonction prend en tant que son argument un string qui est une structure JSON sérialisée. La structure JSON est convertie en XML et wrappée à l'intérieur d'un élément nommé json, et retourné en tant que nœud de document. Par exemple, nous soumissons le document JSON suivant dans un string (c'est à dire, entre guillemets) en tant que l'argument de la function :

{

   "Root": {

      "user": "Altova",

      "message": "Hello",

      "A": {

         "B": "B Text",

         "C": "C Text",

         "D": {

         }

      }

   }

}

La fonction retournera un nœud de document possédant un élément de document nommé json qui contient la structure JSON convertie en XML. L'élément enfant de json sera Root.

Puisqu'il s'agit d'un nœud de document qui est retourné par la fonction, vous pouvez accéder à des parties du document retourné en apposant une expression de localisation XPath à la fonction. Par exemple, si vous évaluez l'expressions suivante (avec l'expression de localisation marquée en jaune) :

mt-load-json-from-string('{

      "A": {

         "B": "B Text",

         "C": "C Text",

         "D": {

         }

      }

}')/json/A/C

elle retourne "C Text".

Utilisation

mt-load-json-from-string('{ "A": "A Text" }') retourne le nœud de document ayant un élément de document nommé json, qui aura un élément enfant nommé A

mt-load-json-from-string('{ "A": "A Text" }')/* retourne tous les éléments du document : c'est à dire, l'élément json avec un élément enfant nommé A.

Description

Retourne le string personnalisé identifié par l'argument StringName. Chaque string personnalisé fait partie d'un groupe de strings qui sont définis dans le dialogue de localisation . Chaque StringName est associé, dans le groupe de strings, à plusieurs lignes de texte localisées. La langue de la ligne de texte localisée sélectionnée est la même que la langue de l'appareil mobile ou que la langue de simulation.

Utilisation

mt-load-string('StringName')

Lorsque la fonction mt-load-string est saisie dans le dialogue d'édition de l'expression XPath/XQuery, toutes les lignes de texte personnalisées disponibles sont affichées dans une fenêtre popup (voir capture d'écran ci-dessous). Pour afficher cette fenêtre popup, placer le curseur entre les apostrophes de limitation ou les guillemets de 'StringName' et cliquer Ctrl+Barre espace.

Faites dérouler la liste en utilisant les touches de flèche Haut et Bas de votre clavier. La valeur du string personnalisé sélectionné est affichée à la droite de la fenêtre popup (voir capture d'écran ci-dessus). La langue de localisation de la valeur affichée est celle de la langue de simulation actuellement sélectionnée dans MobileTogether Designer. Pour saisir le nom d'un string personnalisé dans l'expression XPath, sélectionner le string ou faire défiler la liste des strings personnalisés jusqu'au string que vous souhaitez et appuyer sur Entrée.

mt-localized-string-name(Text as xs:string) asxs:string*

mt-localized-string-name(Text as xs:string, Lang as xs:string) asxs:string*

La fonction prend une valeur texte-string en tant que son (premier) argument dans la langue par défaut ou la langue localisée et retourne le nom de la commande ou du string qui comporte la valeur texte-string soumise en tant que sa valeur de texte. Voir Localisation et Projet | Localisation pour plus d'information. La fonction comporte deux signatures. Dans la seconde signature, la langue du texte-string est le deuxième argument (Lang). L'argument Lang devrait correspondre au nom de la langue localisée. Si Lang est spécifié, les strings de cette langue localisée uniquement sont recherchés pour un texte-string qui correspond au texte-string soumis dans l'argument Text.

Exemple

Les exemples ci-dessus sont destinés à un string sur une commande Bouton nommée CityButton. La langue par défaut du string est l'anglais et a été localisée pour les langues DE et ES.

Description

Retourne true() si la solution a lancé NFC, false() sinon.

Utilisation

mt-nfc-started()

Description

Retourne une liste des pages ouvertes. La liste sera une séquence de strings, c'est a dire qu'elle consistera dans les noms des pages avec un espace entre chaque paire de noms.

Utilisation

mt-page-stack()

Description

Cette fonction est disponible uniquement quand les actions d’indication de progrès sont exécutées. Le réglage par défaut est faux(). Il renvoie true() si l’action d’annulation de l’envoi du progrès est déclenchée alors qu’un ensemble d’actions d’indication de progrès est exécuté. La valeur de cette fonction peut donc être utilisée pour recevoir l’intention de l’utilisateur client de supprimer et de supprimer de manière conséquente les actions de serveur.

Utilisation

Si mt-progress-cancelling()=true(), alors exécutez une/des action/s pour arrêter des actions de serveur et prenez toute autre action dont l’annulation aurait besoin (par exemple, redéfinir une valeur de nœud à une valeur avant l’action).

Description

Charge les rôles d'utilisateur disponibles actuellement depuis le serveur. La fonction met à jour les rôles d'utilisateur qui peuvent être requis par le biais de la variable globale MT_UserRoles.

Utilisation

mt-refresh-userroles()

Description

Retourne l'heure à laquelle la source de page a été rechargée. Si elle n'est pas chargée, une séquence vide est retournée.

Utilisation

mt-reload-dateTime($XML1)

mt-run-appstoreapp-url(Scheme? as xs:string, Host? as xs:string, InputParameters? as xs:string) asxs:string?

mt-run-appstoreapp-url(InputParameters? as xs:string) asxs:string?

Génère l'URL d'une Appli d'AppStore MobileTogether soit depuis (i) les trois arguments soumis, soit (ii) l'argument unique InputParameters. En cliquant sur l'URL, qui généralement sera envoyée dans un e-mail, l'Appli d'AppStore sera lancée. L'URL doit avoir le format : <url-scheme>://<url-host>. Le fichier manifest de l'appli contient l'information de scheme, et cela indique à l'appareil que les URL commençant avec ce scheme serait ouvert par cette appli. Pour plus d'informations concernant les Applis d'AppStore, voir la section Applis d'AppStore.

•Scheme : le nom de scheme unique qui est associé avec l'appli. Le scheme est attribué lorsque le code de programme de l'appli est généré (dans l'Écran 1 de l'Assistant de génération du code de programme).  Si cet argument est omis ou si un string vide est soumis, alors le scheme est défini sur celui de l'appli en cours actuellement.

•Host: le nom d'hôte unique qui est associé avec l'appli. L'hôte est attribué lorsque le code de programme de l'appli est généré (dans l'Écran 1 de l'Assistant de génération du code de programme). Si cet argument est omis ou si un string vide est soumis, alors le nom d'hôte sera celui associé avec l'appli en cours actuellement.

•InputParameters: prend la fonction mt-run-solution-url-parameters en tant que son entrée. L'argument de la fonction est une séquence de valeurs de chaîne qui fournissent les valeurs des paramètres de la requête. La fonction mt-run-solution-url-parameters retourne une chaîne contenant les paramètres (noms et valeurs) de la chaîne de requête de l'URL, correctement codée et échappée avec %, conformément aux règles de codage des chaînes de requêtes URL. Les noms de paramètres dans la chaîne de résultat sont générés automatiquement par la fonction (les noms sont : in1, in2 ... inN), et une valeur est attribuée à chacun d'entre eux depuis les items de chaîne de l'argument de la fonction. Les noms et les valeurs étant classés par paires dans l'ordre de l'index. (De plus, l'argument InputParameters peut être fourni en tant que chaîne déjà codée pour la partie de chaîne de requête d'une URL (voir le second exemple ci-dessous).)

La fonction mt-run-appstoreapp-url crée donc une URL, avec ou sans paramètres de requête qui ouvre une appli d'AppStore MobileTogether. Les paramètres de requête sont passés à l'appli lorsque l'appli est ouverte via l'URL. Les valeurs de ces paramètres peuvent être accédées dans d'autres composants de design en utilisant la variable globale $MT_InputParameters.

Exemples

mt-run-solution-url(ServerAddress? as xs:string, SolutionName? as xs:string, InputParameters? as xs:string) asxs:string?

Génère une URL pour ouvrir la solution spécifiée dans un client MobileTogether. Lorsque l'URL est effleurée, l'appli Altova MobileTogether Client s'ouvre et la solution est lancée dans l'appli. L'URL est générée soit depuis (i) les trois arguments soumis de la fonction (liste ci-dessous), ou (ii) l'argument InputParameters de la fonction.

•ServerAddress: prend le nom ou l'adresse IP du MobileTogether Server sur lequel la solution que vous souhaitez est déployée. Si cet argument est omis ou est le string vide, alors le serveur actuel sera utilisé.

•SolutionName: prend le chemin déployé de la solution sur le serveur. Par exemple : /public/MySolution (qui pointerait vers le fichier MySolution.mtd dans le conteneur /Public). Si cet argument est omis ou est le string vide, alors la solution actuelle sera utilisée.

•InputParameters: prend la fonction mt-run-solution-url-parameters en tant que son entrée. L'argument de la fonctionmt-run-solution-url-parameters est soit (i) une séquence des valeurs de string qui seront les valeurs des paramètres de la requête, soit (ii) un map de paires key:value qui fournissent le nom et la valeur des paramètres respectifs. Cette fonction retourne un string correctement encodé et échappé avec % conformément aux règles d'encodage URL des strings de requête. Voir la description de la fonction mt-run-solution-url-parameters ci-dessous. (De plus, l'argument InputParameters peut être fourni en tant que string déjà codé pour la partie de string de requête d'une URL (voir quatrième exemple ci-dessous).)

La fonction mt-run-solution-url crée donc une URL, avec ou sans paramètres, qui accède à une solution sur un MobileTogether Server. Les paramètres de requête sont transmis à la solution quand celle-ci est ouverte via l'URL. Les valeurs de ces paramètres peuvent être accédées dans d'autres composants de design en utilisant la variable globale $MT_InputParameters.

Exemples

Veuillez noter les points suivants :

•Le premier argument ServerAddress est utilisé pour consulter les informations sur le client concernant un serveur ayant le nom/adresse soumis. Le numéro de port, le nom d'utilisateur et le mot de passe qui sont associés avec le nom du serveur sont ensuite utilisés pour se connecter au serveur. Donc si une URL est générée avec un nom de serveur qui n'est pas reconnu par le client, l'URL ne fonctionnera pas.

•Le deuxième argument, SolutionName: (i) génère le chemin déployé (sur le serveur) si la solution est exécutée sur le serveur, mais (ii) génère un chemin de fichier pour les simulations.

•Le troisième argument, InputParameters, utilise la fonction d'extension XPath spécifique à MobileTogether appelée mt-run-solution-url-parameters pour générer et encoder les paires de valeur de paramètres de la requête. Attention : ne pas confondre la fonction mt-run-solution-url-parameters (qui encode les paramètres de requête) avec la fonction mt-run-solution-url (qui génère toute l'URL).

mt-run-solution-url-parameters((Parameters*) as xs:string) as xs:string?

mt-run-solution-url-parameters(Map as map) as xs:string?

La fonction Mt-run-solution-url-parameters est prévue pour être utilisée en tant que le troisième argument de la fonction mt-run-solution-url. Son argument unique est soit une séquence de valeurs de chaîne soit un mappage de paires de valeur-clé. Le résultat généré est un string unique, qui sera la partie de string de requête qui devra être soumise (en tant qu’argument) dans la fonction mt-run-solution-url. Il contient les paramètres (noms et valeurs) du string de requête, encodés correctement et échappés avec un pourcentage conformément aux règles d’encodage des strings de requête d’URL.

Séquence

L’argument est une séquence de valeurs de chaîne, qui sont les valeurs de paramètre du string de requête. Les noms de paramètre dans le string de résultat sont générés automatiquement par la fonction (il s’agit de : in1, in2 ... inN), chacun se voit attribuer une valeur depuis les items de string de l’argument de la fonction, avec des noms et des valeurs étant jumelées dans l’ordre d’index. Voir les exemples de séquence ci-dessous.

Map

Les paramètres (noms et valeurs) peuvent aussi être soumis en tant que mappage de paires de valeur key:value. Par exemple : map{"key1":"value1", "key2":"value2"}. Le classement des paramètres n’est pas important parce que chaque valeur de paramètre est liée à un nom de paramètre spécifique. Voir les exemples ci-dessous.

Note :   Si le string Parameters contient des doubles guillemets, les remplacer par des guillemets simples. Cela est nécessaire parce que MobileTogether utilise des guillemets doubles pour construire le string paramètres. Vous pouvez utiliser la fonction Xpath replace pour changer les doubles guillemets en guillemets simples : replace(<string>, '"', "'"). Voir aussi les exemples C'est la vie ci-dessous, où le texte doit être délimité par des guillemets doubles (pas des guillemets simples).

Les valeurs de ces paramètres peuvent être accédées dans d'autres composants de design en utilisant la variable globale $MT_InputParameters.

Exemple

mt-run-web-url(ServerAddress? as xs:string, SolutionName? as xs:string, InputParameters? as xs:string) asxs:string?

mt-run-web-url(InputParameters? as xs:string) asxs:string?

Génère une URL, qui est saisie dans un navigateur web, pour ouvrir la solution spécifiée dans le navigateur. L'URL est générée soit depuis (i) les trois arguments soumis de la fonction (liste ci-dessous), ou (ii) l'argument InputParameters de la fonction.

•ServerAddress: prend le nom ou l'adresse IP du MobileTogether Server sur lequel la solution que vous souhaitez est déployée. Si cet argument est omis ou est le string vide, alors le serveur actuel sera utilisé.

•SolutionName: prend le chemin déployé de la solution sur le serveur. Par exemple : /public/MySolution (qui pointerait vers le fichier MySolution.mtd dans le conteneur /Public). Si cet argument est omis ou est le string vide, alors la solution actuelle sera utilisée.

•InputParameters: prend la fonction mt-run-solution-url-parameters en tant que son entrée. L'argument de la fonction est une séquence des valeurs de string qui fournissent les valeurs des paramètres de la requête. La fonction mt-run-solution-url-parameters retourne un string contenant les paramètres (noms et valeurs) du string de requêtes de l'URL, correctement encodé et échappé avec % conformément aux règles d'encodage URL des strings de requête. Les noms des paramètres dans le string de résultat sont automatiquement générés par la fonction (soit : in1, in2 ... inN) et une valeur provenant des éléments de string de l'argument de la fonction est attribuée à chacun d'entre eux, et dont les noms et les valeurs sont associés à un ordre d'index. (De plus, l'argument InputParameters peut être fourni en tant que string déjà codé pour la partie de string de requête d'une URL (voir quatrième exemple ci-dessous).)

La fonction mt-run-web-url crée donc une URL, avec ou sans paramètres, qui accède à une solution sur un MobileTogether Server. Les paramètres de requête sont transmis à la solution quand celle-ci est ouverte via l'URL. Les valeurs de ces paramètres peuvent être accédées dans d'autres composants de design en utilisant la variable globale $MT_InputParameters.

Exemples

Veuillez noter les points suivants :

•Le premier argument ServerAddress est utilisé pour consulter les informations sur le client concernant un serveur ayant le nom/adresse soumis. Le numéro de port, le nom d'utilisateur et le mot de passe qui sont associés avec le nom du serveur sont ensuite utilisés pour se connecter au serveur. Donc si une URL est générée avec un nom de serveur qui n'est pas reconnu par le client, l'URL ne fonctionnera pas.

•Le deuxième argument, SolutionName: (i) génère le chemin déployé (sur le serveur) si la solution est exécutée sur le serveur, mais (ii) génère un chemin de fichier pour les simulations.

•Le troisième argument, InputParameters, utilise la fonction d'extension XPath spécifique à MobileTogether appelée mt-run-solution-url-parameters pour générer et encoder les paires de valeur de paramètres de la requête. Attention : ne pas confondre la fonction mt-run-solution-url-parameters (qui encode les paramètres de requête) avec la fonction mt-run-solution-url (qui génère toute l'URL).

Description

Prend un nœud JSON en tant que son argument unique et retourne le contenu du nœud en tant qu'un string sérialisé dans un format JSON. Le nœud JSON soumis peut être un document JSON complet ou bien une partie d'un document JSON : par exemple, vous avez le document JSON suivant et vous l'avez associé à une source de page JSON nommée $JSON1 :

{

   "Root": {

      "user": "Altova",

      "message": "Hello",

      "A": {

         "B": "B Text",

         "C": "C Text",

         "D": {

         }

      }

   }

}

Si le nœud de document est soumis (c'est à dire, $JSON1, qui est le nœud virtuel qui constitue le nœud parent du document), alors les contenus de l'ensemble de l'objet de document est retourné en tant que string. Si le nœud $JSON1/json//Root est soumis en tant que l'argument, lors l'objet qui est la valeur de la clé "Root" est retourné en tant que clé. Voir aussi les exemples ci-dessous.

Utilisation

mt-save-json-to-string($JSON/json/Root/A/B) retourne '"B Text"'

mt-save-json-to-string($JSON/json/Root/A/D) retourne '{}'

mt-server-config-url(ServerSettings as map) asxs:string?

La fonction mt-server-config-url prend un mappage en tant que son argument et retourne un string sous forme d'URL. Lorsque l'URL est envoyée en tant que lien aux appareils client, et que le lien est cliqué, les configurations de serveur sur le client sont automatiquement mises à jour. L'URL ressemblera à : mobiletogether://mt/change-settings?settings=<json encoded settings>

Les paramètres de serveur codés JSON qui sont contenus dans l'URL sont fournis par l'argument ServerSettings de la fonction mt-server-config-url. Le mappage ServerSettings est indiqué ci-dessous. Pour voir un exemple de l'utilisation de cette fonction, ouvrir et tester le fichier d'exemple ClientConfiguration.mtd dans le dossier MobileTogetherExamples/SimpleApps.

mt-server-config-url(

map{

   "DelOthSrv": false(),   (: whether existing server list should be deleted before import :)

   "DetView": true(),     (: whether the details view should be used or the grid :)

   "Refresh": true(),     (: refresh solutions on start :)

   "RetToSln": true(),     (: Windows clients only :)

   "ActSrvURL": "",       (: the first server with this URL gets the active one :)

   "Servers": array{

      map{

        "Name": "",

        "URL": "",         (: if DelOthSrv is false then this property is used as key to merge the new settings with the existing ones :)

        "LoginProvider": map{

            "NameSuffix": "",

            "NamePrefix": "",

                            },

        "Port": "",

        "User": "",

        "StorePW": true(),

        "Password": "",

        "SSL": false()

        }                 (: , map {...} to add another server :)

                    }

    }

)

mt-server-variable(VariableName comme xs:string) comme xs:string

Retourne la valeur de la variable de serveur nommée dans l’argument VariableName. Les variables de serveur sont des variables stockées dans le fichier mobiletogetherserver.cfg (voir manuel utilisateur MobileTogether Server. Dans ce fichier, les variables de serveur sont stockées dans la section [Server Variables], tel qu’affiché dans le snippet ci-dessous :

[VariablesServeur]

Environment=Portal

Manual=AdminDocs

StartPage=Admin

Le fichier mobiletogetherserver.cfg est situé par défaut dans le dossier de données de l’application MobileTogether Server. Vous pouvez éditer le fichier de configuration .cfg dans un éditeur de texte. Voir le manuel utilisateur MobileTogether Server pour plus d’information.

 Pour plus d'informations concernant la manière de simuler des variables de serveur, voir l'onglet Options Simulation 2.

Exemples

mt-solution-path() en tant que xs:string

Retourne le chemin de la solution exécutée actuellement.

mt-string-to-hexBinary(Text as xs:string, Encoding comme xs:string) comme xs:string

mt-string-to-hexBinary(Text comme xs:string) comme xs:string

La fonction convertit un string de texte en un string hexBinary. Un nœud qui renvoie un string de texte peut être soumis comme argument Text. Une fonction lit le string Text comme ayant l’encodage spécifié dans l’argument Encoding. Si le string vide est fourni comme argument Encodage ou si aucun argument Encodage n’est fourni, alors l’encodage par défaut 'UTF-8' est utilisé.

Exemples

mt-table-rowgroup-count(VisibleOnly? as xs:boolean) asxs:integer

La fonction doit se trouver dans un groupe de ligne qui devient le contexte de la fonction. Celle-ci retourne le nombre (count) de groupe de ligne dans la table dans laquelle le groupe de ligne contextuel est situé. L'argument VisibleOnly est optionnel ; il peut avoir la valeur de true() ou false(). Si défini sur true(), la fonction retourne le décompte des groupes de ligne visibles dans la table ; si défini sur false(), la fonction retourne le décompte de tous les groupes de ligne (visibles et invisibles). (Les groupes de ligne visibles sont des groupes de ligne dont la propriété Visible est réglée sur true; voir ici pour une description des propriétés de table.) Si l'argument optionnel VisibleOnly n'est pas soumis, alors le décompte des groupes de ligne visibles est retourné ; l'effet est le même que si vous soumettiez l'argument VisibleOnly avec une valeur de true().

Note :  si la propriété Visible d'un groupe de ligne a été défini, un groupe de ligne enfant ne peut pas utiliser la fonction mt-table-rowgroup-count pour des groupes de ligne visibles.

Exemples

mt-table-rowgroup-index(VisibleOnly? as xs:boolean) asxs:integer

La fonction doit se trouver dans un groupe de ligne qui devient le contexte de la fonction. La fonction retourne la position (ou l'index) du groupe de ligne actuel dans le cadre du nombre total de groupes de lignes de la table actuelle. Si l'argument optionnel VisibleOnly est défini sur true(), alors la fonction retourne l'index du groupe de lignes actuel dans le cadre des groupes de lignes visible de la table ; si défini sur false(), l'index parmi tous les groupes de ligne (visible et invisible) est retourné. (Les groupes de lignes visibles sont des groupes de lignes dont la propriété Visible est définie sur true; voir ici pour une description des propriétés de table.) Si l'argument optionnel VisibleOnly n'est pas soumis, l'index parmi les groupes de lignes est retourné.

Exemples

mt-test-case-run() asmap(*)

Retourne un mappage contenant des informations concernant la marche de test exécutée actuellement. Le mappage contiendra les paires key:value suivantes : "name":<the name of the test case>, "step":<the current step>, "count":<the total number of steps>. Si aucune lecture n'est en cours actuellement, la clé du mappage contiendra des valeurs vides.

Exemples

mt-text-to-speech-is-language-available(Langage en tant que xs:string) en tant que xs:boolean

L'argument Langue peut prendre des valeurs de string dans la forme en (code de langue) ou en-US (code de pays de langue). Si la lange spécifiée dans l'argument Langue est disponible sur l'appareil mobile, la fonction retourne true(), sinon false().

Utilisation

mt-text-to-speech-is-language-avaialable("en") retourne true() si en ou toute variante de langage en-<country> est disponible sur l'appareil mobile, false() dans le cas contraire.

mt-text-to-speech-is-language-available("en-US") retourne true() si en-US est disponible sur l'appareil mobile, false() dans le cas contraire.

mt-text-to-speech-is-speaking() asxs:boolean

Retourne true() si la lecture d'une action Parole en texte est en cours, sinon false().

Voir la description de cette fonction dans la section Fonctions liées à l'image des Fonctions d'extension Altova.

Description

Si l'utilisateur a appuyé sur le bouton Retour ou essaye de quitter la solution, la fonction retourne true(). Dans le cas contraire, false() est retourné (la valeur par défaut).

Utilisation

mt-user-tried-to-cancel-actions()

mt-video-get-current-position(VideoControlName as xs:string) asxs:integer

Prend le nom d'une commande vidéo en tant que son argument et retourne la position de lecture actuelle (en secondes) de la vidéo qui est jouée dans la commande vidéo. Si aucune vidéo n'est jouée dans la commande, une erreur est retournée. Veuillez noter que les informations concernant la position actuelle ne seront disponibles qu'après le démarrage de la lecture, cette fonction ne devrait donc être utilisée qu'après le démarrage de lecture.

Utilisation

mt-video-get-current-position("Video-01") retourne la position actuelle de la vidéo jouant dans la commande vidéo nommée Video-01.

mt-video-get-duration(VideoControlName as xs:string) asxs:integer

Prend le nom d'une commande vidéo en tant que son argument et retourne la durée (en secondes) de la vidéo qui est jouée dans cette commande vidéo. Si aucune vidéo n'est jouée dans la commande, une erreur est retournée. Veuillez noter que les informations concernant la durée actuelle ne seront disponibles qu'après le démarrage de la lecture, cette fonction ne devrait donc être utilisée qu'après le démarrage de lecture.

Utilisation

mt-video-get-duration("Video-01") retourne la durée de la vidéo jouée dans la commande vidéo nommée Video-01.

mt-video-height(VideoControlName as xs:string) asxs:integer

Prend le nom d'une commande vidéo en tant que son argument et retourne la hauteur (en pixels) de la vidéo qui est jouée dans cette commande vidéo. Si aucune vidéo n'est jouée, une erreur est retournée. Veuillez noter que les informations concernant la hauteur de la vidéo ne seront disponibles qu'après le démarrage de la lecture, cette fonction ne devrait donc être utilisée qu'après le démarrage de lecture.

Utilisation

mt-video-height("Video-01") retourne la hauteur de la vidéo jouant dans la commande vidéo nommée Video-01.

mt-video-is-playing(VideoControlName as xs:string) asxs:boolean

Prend le nom d'une commande vidéo en tant que son argument et retourne true() si une vidéo joue dans cette commande de vidéo, sinon false().

Utilisation

mt-video-is-playing("Video-01") retourne true() si une vidéo est jouée dans la commande vidéo nommée, sinon Video-01, false().

mt-video-width(VideoControlName as xs:string) asxs:integer

Prend le nom d'une commande vidéo en tant que son argument et retourne la largeur (en pixels) de la vidéo qui est jouée dans cette commande vidéo. Si aucune vidéo n'est jouée, une erreur est retournée. Veuillez noter que les informations concernant la largeur de la vidéo ne seront disponibles qu'après le démarrage de la lecture, cette fonction ne devrait donc être utilisée qu'après le démarrage de lecture.

Utilisation

mt-video-width("Video-01") retourne la largeur de la vidéo jouant dans la commande vidéo nommée Video-01.

Description

Retourne true()si l'appareil client affiche son curseur Attendre, false() sinon.

Utilisation

mt-wait-cursor-shown()

Description

Retourne true() si un scanneur Zebra est actuellement connecté à la solution par une des actions recensées ci-dessous, autrement false().

•Zebra Se connecter/déconnecter

•Zebra Mobile Se connecter/déconnecter

Utilisation

mt-zebra-scanner-connected()

Description

Retourne l'ID du scanneur Zebra actuellement connecté, ou retourne -1 si aucun scanneur Zebra n'est actuellement connecté.

Utilisation

mt-zebra-scanner-id()