Pour lancer vos requête sur l'API OVH
Composant Class OVH
OVH_API_Application_name est une chaîne = ""
OVH_API_Application_description est une chaîne = ""
OVH_API_Application_key___AK est une chaîne = ""
OVH_API_Application_secret___AS est une chaîne = ""
OVH_API_Consumer_Key___CK est une chaîne = ""
clAsovh est C_OVH( OVH_API_Application_key___AK, ...
OVH_API_Application_secret___AS,...
OVH_API_Consumer_Key___CK,...
OVH_ovh_eu)
Exemple :
clAsovh.Email__RedirectionEnregistre("coro.com","126@coro.com","aulie@re.fr")
Les entrées/sorties du composant :
Liste des procédures
Le composant Class OVH propose les collections de procédures suivantes :
Collection de procédures 'COL_classe_OVH'
Liste des classes
Le composant Class OVH propose les classes suivantes :
Liste des structures
Le composant Class OVH propose les structures suivantes :
Collection de procédures 'COL_classe_OVH'
ST_OVH_SMS
1 - Collections de procédures accessibles
1.1 - Collection de procédures 'COL_classe_OVH'
1 - Collections de procédures navigateur accessibles
<Pas de procédure navigateur disponible dans ce composant>
2 - Classes accessibles
2.1 - Classe 'C_OVH'
2.1.1 - Méthode 'Constructeur'
2.1.2 - Méthode 'Destructeur'
2.1.3 - Méthode 'Email__RedirectionLit'
Résumé : <indiquez ici ce que fait la procédure>
Syntaxe :
[ <Résultat> = ] Email__RedirectionLit (<sDomaine> est chaîne [, <sFrom> est chaîne [, <sTo> est chaîne]])
Paramètres :
sDomaine (chaîne ANSI) : <indiquez ici le rôle de sDomaine>
sFrom (chaîne ANSI) : <indiquez ici le rôle de sFrom>
sTo (chaîne ANSI) : <indiquez ici le rôle de sTo>
Valeur de retour :
booléen : <indiquez ici les valeurs possibles ainsi que leur interprétation>
Exemple :
Indiquez ici un exemple d'utilisation.
2.1.4 - Méthode 'Email__RedirectionLitId'
Résumé : <indiquez ici ce que fait la procédure>
Syntaxe :
[ <Résultat> = ] Email__RedirectionLitId (<sDomaine> est chaîne, <sIdRedeirection> est chaîne)
Paramètres :
sDomaine (chaîne ANSI) : <indiquez ici le rôle de sDomaine>
sIdRedeirection (chaîne ANSI) : <indiquez ici le rôle de sIdRedeirection>
Valeur de retour :
booléen : <indiquez ici les valeurs possibles ainsi que leur interprétation>
Exemple :
Indiquez ici un exemple d'utilisation.
2.1.5 - Méthode 'Email__RedirectionSupprimeId'
Résumé : <indiquez ici ce que fait la procédure>
Syntaxe :
[ <Résultat> = ] Email__RedirectionSupprimeId (<sDomaine> est chaîne, <sIdRedeirection> est chaîne)
Paramètres :
sDomaine (chaîne ANSI) : <indiquez ici le rôle de sDomaine>
sIdRedeirection (chaîne ANSI) : <indiquez ici le rôle de sIdRedeirection>
Valeur de retour :
booléen : <indiquez ici les valeurs possibles ainsi que leur interprétation>
Exemple :
Indiquez ici un exemple d'utilisation.
2.1.6 - Méthode 'Email__RedirectionModifieId'
Résumé : <indiquez ici ce que fait la procédure>
Syntaxe :
[ <Résultat> = ] Email__RedirectionModifieId (<sDomaine> est chaîne, <sIdRedeirection> est chaîne, <sTo> est chaîne)
Paramètres :
sDomaine (chaîne ANSI) : <indiquez ici le rôle de sDomaine>
sIdRedeirection (chaîne ANSI) : <indiquez ici le rôle de sIdRedeirection>
sTo (chaîne ANSI) : <indiquez ici le rôle de sTo>
Valeur de retour :
booléen : <indiquez ici les valeurs possibles ainsi que leur interprétation>
Exemple :
Indiquez ici un exemple d'utilisation.
2.1.7 - Méthode 'SMS__Envois'
Résumé : <indiquez ici ce que fait la procédure>
Syntaxe :
[ <Résultat> = ] SMS__Envois (<sServiceName> est chaîne, <tab_SMS> est tableau)
Paramètres :
sServiceName (chaîne ANSI) : <indiquez ici le rôle de sServiceName>
tab_SMS (tableau) : <indiquez ici le rôle de tab_SMS>
Valeur de retour :
booléen : <indiquez ici les valeurs possibles ainsi que leur interprétation>
Exemple :
Indiquez ici un exemple d'utilisation.
2.1.8 - Méthode 'SMS__EnvoisViaURL_http2sms'
Résumé : <indiquez ici ce que fait la procédure>
Syntaxe :
[ <Résultat> = ] SMS__EnvoisViaURL_http2sms (<sServiceName> est chaîne, <sLogin> est chaîne, <sPasse> est chaîne, <tab_SMS> est tableau)
Paramètres :
sServiceName (chaîne ANSI) : <indiquez ici le rôle de sServiceName>
sLogin (chaîne ANSI) : <indiquez ici le rôle de sLogin>
sPasse (chaîne ANSI) : <indiquez ici le rôle de sPasse>
tab_SMS (tableau) : <indiquez ici le rôle de tab_SMS>
Valeur de retour :
booléen : <indiquez ici les valeurs possibles ainsi que leur interprétation>
Exemple :
Indiquez ici un exemple d'utilisation.
2.1.9 - Méthode 'Email__RedirectionCréer'
Résumé : <indiquez ici ce que fait la procédure>
Syntaxe :
[ <Résultat> = ] Email__RedirectionCréer (<sDomaine> est chaîne, <sFrom> est chaîne, <sTo> est chaîne [, <bLocalCopy> est booléen])
Paramètres :
sDomaine (chaîne ANSI) : <indiquez ici le rôle de sDomaine>
sFrom (chaîne ANSI) : <indiquez ici le rôle de sFrom>
sTo (chaîne ANSI) : <indiquez ici le rôle de sTo>
bLocalCopy (booléen - valeur par défaut=0) : <indiquez ici le rôle de bLocalCopy>
Valeur de retour :
booléen : <indiquez ici les valeurs possibles ainsi que leur interprétation>
Exemple :
Indiquez ici un exemple d'utilisation.
2.1.10 - Méthode 'Email__RedirectionEnregistre'
Résumé : Enregistre une redirection : la crée au besoin Email__RedirectionCréer supprime les doublon Email__RedirectionSupprimeId ou Modifie la redirection Email__RedirectionModifieId
Syntaxe :
[ <Résultat> = ] Email__RedirectionEnregistre (<sDomaine> est chaîne, <sFrom> est chaîne, <sTo> est chaîne [, <bLocalCopy> est booléen [, <bSansDoublonRedirection> est booléen]])
Paramètres :
sDomaine (chaîne ANSI) : <indiquez ici le rôle de sDomaine>
sFrom (chaîne ANSI) : <indiquez ici le rôle de sFrom>
sTo (chaîne ANSI) : <indiquez ici le rôle de sTo>
bLocalCopy (booléen - valeur par défaut=0) : <indiquez ici le rôle de bLocalCopy>
bSansDoublonRedirection (booléen - valeur par défaut=1) : <indiquez ici le rôle de bSansDoublonRedirection>
Valeur de retour :
booléen : <indiquez ici les valeurs possibles ainsi que leur interprétation>
Exemple :
Indiquez ici un exemple d'utilisation.
2.1.11 - Méthode '_SendRequêteAPI'
Résumé : Envois votre requête sur API OVH
Syntaxe :
[ <Résultat> = ] _SendRequêteAPI (<eMETHOD> est COL_classe_OVH.OVH_Methode, <sPATH> est chaîne [, <sCONTENT> [, <bIs_authenticated> est booléen]])
Paramètres :
eMETHOD (COL_classe_OVH.OVH_Methode) : <indiquez ici le rôle de eMETHOD>
sPATH (chaîne ANSI) : <indiquez ici le rôle de sPATH>
sCONTENT (valeur par défaut="") : <indiquez ici le rôle de sCONTENT>
bIs_authenticated (booléen - valeur par défaut=1) : <indiquez ici le rôle de bIs_authenticated>
Valeur de retour :
httpRéponse : <indiquez ici les valeurs possibles ainsi que leur interprétation>
Exemple :
Indiquez ici un exemple d'utilisation.
2.1.12 - Propriété 'RéponseJson'
2.1.13 - Propriété 'MessageErreur'
3 - Pages accessibles
<Pas de page disponible dans ce composant>
3 - Fenêtres accessibles
<Pas de fenêtre disponible dans ce composant>
4 - Etats accessibles
<Pas d'état disponible dans ce composant>
5 - Manipulation des éléments accessibles
Pour manipuler un élément du composant (fenêtre, etc.) par programmation, il suffit de manipuler l'élément comme s'il s'agissait d'un élément créé dans le projet :
- pour appeler une procédure : utilisez la syntaxe habituelle :
ProcédureDuComposant(Param1,Param2)
- pour utiliser une classe : déclarer une variable du type de la classe :
MaVariable est un objet ClasseDuComposant
La variable s'utilise par la suite comme une variable objet normale.
- pour ouvrir une fenêtre : utilisez par exemple la fonction Ouvre en passant si nécessaire les paramètres attendus par cette fenêtre.
Ouvre(FenêtreDuComposant [, Param1, Param2])
- pour imprimer un état : utilisez la fonction iImprimeEtat en passant si nécessaire les paramètres attendus par cet état.
iImprimeEtat(EtatComposant [, Param1, Param2])