{"id":15983,"date":"2015-02-09T10:07:16","date_gmt":"2015-02-09T09:07:16","guid":{"rendered":"http:\/\/puship.com\/?page_id=15983"},"modified":"2020-07-20T18:13:39","modified_gmt":"2020-07-20T17:13:39","slug":"guida-common","status":"publish","type":"page","link":"https:\/\/www.puship.com\/it\/documentazione\/guida-common\/","title":{"rendered":"libreria Puship"},"content":{"rendered":"\n

Questa pagina documenta tutti i metodi comuni presenti nella libreria javascript del Puship-Plugin, questo significa che i metodi qui presenti sono compatibili con tutte le piattaforme e andranno a produrre gli stessi risultati.<\/p>\n

Tutti i metodi comuni si trovano all’interno della variabile Puship<\/strong><\/p>\n

 <\/p>\n

\n
    \n
  1. Registrazione del device<\/a><\/li>\n
  2. Gestione Tags<\/a>\n
      \n
    1. Aggiunta<\/a><\/li>\n
    2. Rimozione<\/a><\/li>\n
    3. Clean<\/a><\/li>\n<\/ol>\n<\/li>\n
    4. Ricezione delle notifiche push<\/a><\/li>\n
    5. Lettura notifiche Push<\/a>\n
        \n
      1. Lettura semplice<\/a><\/li>\n
      2. Lettura per device<\/a><\/li>\n<\/ol>\n<\/li>\n
      3. Eliminazione di una notifica<\/a><\/li>\n
      4. Registrare una posizione<\/a>\n
          \n
        1. Registrazione Manuale<\/a><\/li>\n
        2. Registrazione Automatica<\/a><\/li>\n
        3. Disabilitazione Registrazione Automatica<\/a><\/li>\n<\/ol>\n<\/li>\n
        4. Deregistrare un device<\/a><\/li>\n<\/ol>\n<\/div>\n

           <\/p>\n

          <\/a>Registrazione del device<\/h2>\n

          La registrazione del device \u00e8 ora comune fra tutte le piattaforme. Prima di chiamare il metodo Register<\/b> di Puship va per\u00f2 configurato il Phonegap-Push-Plugin<\/i> e installato il Puship-plugin<\/i>.\nTrovate una guida per tutte le piattaforme a questo link<\/a>, oppure un esempio specifico per cordova CLI a questo link<\/a>.<\/p>\n

          Register(<\/strong>registrationID, <\/strong>pushipID)<\/strong><\/p>\n

          Register(<\/strong>registrationID, <\/strong>pushipID, <\/strong>options)<\/strong><\/p>\n

          Di seguito trovate un esempio:<\/p>\n\n\n\n

          <\/path><\/svg><\/div>
          Puship.Register(\n\tdata.registrationId,\n\t'YOUR-PUSHIP-APP-CODE',\n\t{\n\t\tsuccessCallback: function (pushipresult) {\n\t\t\talert(\"device registered with DeviceId:\" + pushipresult.DeviceId());\n\t\t},\n\t\tfailCallback: function (pushipresult) {\n\t\t\talert(\"error during registration: \"+ JSON.stringify(pushipresult));\n\t\t}\n\t}\n);<\/pre><\/div>\n\n\n\n
          L’opzione registrationID<\/strong> \u00e8 il data.registrationId<\/i> generato dal Phonegap push plugin nel metodo push.on(‘registration’, callback).
          L’opzione pushipID<\/strong> \u00e8 l’AppCode generato quando crei l’applicazione nel puship manager.<\/p>\n
           <\/p>\n
          <\/a>Gestione Tags<\/h2>\n
          I tag non sono altro che dei filtri associabili a un determinato device. In questo modo si riescono ad inviare le notifiche push selettivamente creando maggiori opportunit\u00e0 di interazione con l’applicazione e quindi con l’utente.
          Ad esempio si possono creare dei tag per ogni segno zodiacale, per poi inviare l’oroscopo selettivamente, via notifica push, ad ogni determinato tag\u2026 forte no?<\/p>\n
           <\/p>\n
          <\/a>Aggiungere Tags<\/h3>\n
          E’ possibile aggiungere dei tag al dispositivo attraverso i seguenti metodi:<\/p>\n
          AddTagFilter(<\/strong>tag)<\/strong><\/p>\n
          AddTagFilter(<\/strong>tag, <\/strong>options)<\/strong><\/p>\n
          Di seguito trovate un esempio:<\/p>\n\n\n\n
          <\/path><\/svg><\/div>
          Puship.AddTagFilter(\n\t\"Virgin\", \n\t{removePrevTag: true}\n);<\/pre><\/div>\n\n\n\n
          L’opzione removePrevTag<\/strong> consente di rimuovere i tag precedentemente inseriti.<\/p>\n
           <\/p>\n
          <\/a>Rimuovere Tags<\/h3>\n
          E’ possibile rimuovere dei tag al dispositivo attraverso il seguente metodo:<\/p>\n
          RemoveTagFilter(<\/strong>tag)<\/strong><\/p>\n
          Di seguito trovate un esempio:<\/p>\n\n\n\n
          <\/path><\/svg><\/div>
          Puship.RemoveTagFilter(\"Virgin\");<\/pre><\/div>\n\n\n\n
           <\/p>\n
          <\/a>Pulisci Tags<\/h3>\n
          Per poter rimuovere tutti i tag precedentemente associati \u00e8 sufficiente chiamare il metodo CleanTagFilter:<\/p>\n
          CleanTagFilter()<\/strong><\/p>\n
          Di seguito trovate un esempio:<\/p>\n\n\n\n
          <\/path><\/svg><\/div>
          Puship.CleanTagFilter();<\/pre><\/div>\n\n\n\n
           <\/p>\n
          <\/a>Ricezione delle notifiche push<\/h2>\n
          La ricezione delle notifiche \u00e8 gestita completamente dal phonegap-push-plugin, \u00e8 possibile trovare una guida dettagliata a questo link<\/a>. Di norma viene inserita nel onDeviceReady<\/i> dopo la chiamata al PushNotification.init<\/i><\/p>\n
          Di seguito trovate un esempio:<\/p>\n\n\n\n
          <\/path><\/svg><\/div>
          push.on('notification', data => {\n  console.log(data.message);\n  console.log(data.title);\n  console.log(data.count);\n  console.log(data.sound);\n  console.log(data.image);\n  console.log(data.additionalData);\n});<\/pre><\/div>\n\n\n\n
           <\/p>\n
          <\/a>Lettura notifiche Push<\/h2>\n
          La lettura delle notifiche push pu\u00f2 essere effettuata sia in modalit\u00e0 semplice, sia in riferimento al device che ne sta facendo richiesta.<\/p>\n
           <\/p>\n
          <\/a>Lettura semplice<\/h3>\n
          La lettura semplice consente di accedere alle tutte le notifiche basandosi solamente sul filtro utilizzato (se utilizzato), questo permette di accedere a notifiche push passate, inviate cio\u00e8 prima che il device si registrasse per la ricezione.
          Il seguente metodo ritorna le push in modalit\u00e0 semplice:<\/p>\n
          GetPushMessages(<\/strong>options)<\/strong><\/p>\n
          Di seguito trovate un esempio:<\/p>\n\n\n\n
          <\/path><\/svg><\/div>
          Puship.GetPushMessages(\n\t{\n\t\/\/limit: 10, \/\/max limit is 50 default is 20\n\t\/\/offset: 100,\n\t\/\/includeParams: true,\n\tbyCurrentPosition: false,\n\ttag : \"Libra\",\n\tsuccessCallback: function (regresult){\n\t\tconsole.log(\"GetPushMessages done\");\n\t\t\n\t\tif (regresult.length > 0)\n\t\t{\n\t\t\tconsole.log(\"PushMessageId: \" + regresult[0].PushMessageId);\n\t\t\tconsole.log(\"Param1: \"+ regresult[0][\"Params\"].Param1); \/\/ visibile solo se includeParams \u00e8 True\n\t\t\tconsole.log(\"Param2: \"+ regresult[0][\"Params\"].Param2);\n\t\t\talert(\"Message 1 of \"+regresult.length+\": \"+regresult[0].Message);\n\t\t}else{\n\t\t\talert(\"No message found\");\n\t\t}\n\t},\n\tfailCallback: function (regresult){\n\t\talert(\"error during GetPushMessages: \"+ regresult);\n\t}\n});<\/pre><\/div>\n\n\n\n
          L’opzione limit<\/strong> consente di limitare il numero di push ricevute dalla funzione.
          L’opzione offset<\/strong> consente di impostare un puntatore di partenza per la query delle notifiche.
          L’opzione includeParams<\/strong> consente di ritornare anche i parametri assegnati alla notifica corrente.
          L’opzione byCurrentPosition<\/strong> consente di filtrare per le notifiche push in base alla posizione corrente del device.
          L’opzione tag<\/strong> consente di filtare le notifiche in base ai tag alle quali sono state associate.
          L’opzione addDevicePush<\/strong> consente di aggiungere ai risultati dei precedenti filtri tutte le notifiche che il dispositivo ha ricevuto dal momento in cui \u00e8 stato registrato.<\/p>\n
           <\/p>\n
          <\/a>Lettura per device<\/h3>\n
          La ricezione per device \u00e8 invece pi\u00f9 restrittiva, essa ritorna solo le notifiche che sono state inviate specificatamente a questo determinato device.
          Il seguente metodo ritorna le push in riferimento al device:<\/p>\n
          GetPushMessagesByDevice(<\/strong>options)<\/strong><\/p>\n
          Di seguito trovate un esempio:<\/p>\n\n\n\n
          <\/path><\/svg><\/div>
          Puship.GetPushMessagesByDevice(\n\t{\n\t\/\/limit: 10, \/\/max limit is 50 default is 20\n\t\/\/offset: 100,\n\t\/\/includeParams: true,\n\tsuccessCallback: function (regresult){\n\t\tconsole.log(\"GetPushMessagesByDevice done\");\n\t\t\n\t\tif (regresult.length > 0)\n\t\t{\n\t\t\tconsole.log(\"PushMessageId: \" + regresult[0].PushMessageId);\n\t\t\tconsole.log(\"Param1: \"+ regresult[0][\"Params\"].Param1); \/\/ visibile solo se includeParams \u00e8 True\n\t\t\tconsole.log(\"Param2: \"+ regresult[0][\"Params\"].Param2);\n\t\t\talert(\"Message 1 of \"+regresult.length+\": \"+regresult[0].Message);\n\t\t}else{\n\t\t\talert(\"No message found\");\n\t\t}\n\t},\n\tfailCallback: function (regresult){\n\t\talert(\"error during GetPushMessagesByDevice: \"+ regresult);\n\t}\n});<\/pre><\/div>\n\n\n\n
          L’opzione limit<\/strong> consente di limitare il numero di push ricevute dalla funzione.
          L’opzione offset<\/strong> consente di impostare un puntatore di partenza per la query delle notifiche.
          L’opzione includeParams<\/strong> consente di ritornare anche i parametri assegnati alla notifica corrente.<\/p>\n
          Negli esempi scaricabili per la registrazione delle varie piattaforme \u00e8 possibile trovare anche il codice di esempio per la lettura delle notifiche.<\/p>\n
           <\/p>\n
          <\/a>Eliminazione di una notifica<\/h2>\n
          Chiamando questa funzione sar\u00e0 possibile eliminare una notifica dal server puship.<\/p>\n
          DeletePushMessage(<\/strong>PushMessageId)<\/strong><\/p>\n
          DeletePushMessage(<\/strong>PushMessageId, <\/strong>options)<\/strong><\/p>\n
          Di seguito trovate un esempio:<\/p>\n\n\n\n
          <\/path><\/svg><\/div>
          Puship.DeletePushMessage(\"APKCbOd72fXKVUU_4be87030-2eda-11e4-8c21-0800200c9a66\",\n\t{\n\tsuccessCallback: function (regresult){\n\t\talert(\"Message deleted\");\n\t},\n\tfailCallback: function (regresult){\n\t\talert(\"Message delete error: \"+ regresult);\n\t}\n});<\/pre><\/div>\n\n\n\n
          Negli esempi scaricabili per la registrazione delle varie piattaforme \u00e8 possibile trovare anche il codice di esempio per l’eliminazione di una notifica.<\/p>\n
           <\/p>\n
          <\/a>Registrare una posizione<\/h2>\n
          La registrazione delle posizioni pu\u00f2 essere effettuata sia in modalit\u00e0 manuale, sia in modalit\u00e0 automatica.<\/p>\n
           <\/p>\n
          <\/a>Registrazione Manuale<\/h3>\n
          Chiamando questa funzione sar\u00e0 possibile registrare in qualsiasi momento la posizione del dispositivo. E’ buona norma aggiornare la posizione al momento dell’avvio dell’applicazione ma nulla vieta che essa sia effettuata pi\u00f9 di frequente in modo da fornire una geolocalizzazione pi\u00f9 accurata.<\/p>\n
          RegisterCurrentPosition(<\/strong>)<\/strong><\/p>\n
          RegisterCurrentPosition(<\/strong>options)<\/strong><\/p>\n
          Di seguito trovate un esempio:<\/p>\n\n\n\n
          <\/path><\/svg><\/div>
          Puship.RegisterCurrentPosition(\n\t{\n\t\/\/callMinutes: 1,\n\t\/\/enableHighAccuracy: true,\n\t\/\/minimumAccuracy: 50, \/\/Esclude le posizioni con accuratezza rilevata > 50 metri\n\tsuccessCallback: function (regresult){\n\t\talert(\"Position registration done\");\n\t},\n\tfailCallback: function (regresult){\n\t\talert(\"Position registration error: \"+ regresult);\n\t}\n});<\/pre><\/div>\n\n\n\n
          L’opzione callMinutes<\/strong> consente di impostare il tempo fra una chiamata e la successive al server puship, per ottimizzare l’utilizzo della banda. Non \u00e8 possibile impostare un valore minore di 1 minuti.
          L’opzione enableHighAccuracy<\/strong> consente di forzare l’utilizzo del GPS.
          L’opzione minimumAccuracy<\/strong> consente di escludere le posizioni rilevate con una accuratezza rilevata minore di quella impostata. Se l’accuratezza rilevata \u00e8 NULL la posizione non viene mai scartata<\/p>\n
           <\/p>\n
          <\/a>Registrazione Automatica<\/h3>\n
          Chiamando questa funzione sar\u00e0 possibile attivare la registrazione automatica della posizione del device. Questa funzionalit\u00e0 sfrutta la funzione WatchPosition di Phonegap.<\/p>\n
          ActivateWatchPosition()<\/strong><\/p>\n
          ActivateWatchPosition(<\/strong>options)<\/strong><\/p>\n
          Di seguito trovate un esempio:<\/p>\n\n\n\n
          <\/path><\/svg><\/div>
          Puship.ActivateWatchPosition({\n\t\/\/callMinutes: 5,\n\t\/\/enableHighAccuracy: true,\n\t\/\/minimumAccuracy: 50, \/\/Esclude le posizioni con accuratezza rilevata > 50 metri\n});<\/pre><\/div>\n\n\n\n
          L’opzione callMinutes<\/strong> consente di impostare il tempo fra una chiamata e la successive al server puship, per ottimizzare l’utilizzo della banda. Non \u00e8 possibile impostare un valore minore di 5 minuti.
          L’opzione enableHighAccuracy<\/strong> consente di forzare l’utilizzo del GPS.
          L’opzione minimumAccuracy<\/strong> consente di escludere le posizioni rilevate con una accuratezza rilevata minore di quella impostata. Se l’accuratezza rilevata \u00e8 NULL la posizione non viene mai scartata<\/p>\n
          Attenzione: Alcune versioni dei sistemi operativi disabilitano by design la geolocalizzazione quando il device viene bloccato o si esce dall’applicazione.<\/p>\n
           <\/p>\n
          <\/a>Disabilitazione Registrazione Automatica<\/h3>\n
          Chiamando questa funzione sar\u00e0 possibile disattivare la registrazione automatica della posizione del device.<\/p>\n
          StopWatchPosition()<\/strong><\/p>\n
          Di seguito trovate un esempio:<\/p>\n\n\n\n
          <\/path><\/svg><\/div>
          Puship.StopWatchPosition();<\/pre><\/div>\n\n\n
           <\/p>\n
          <\/a>Deregistrare un device<\/h2>\n
          A volte pu\u00f2 essere necessario deregistrare il dispositivo, per farlo \u00e8 sufficiente uno dei seguenti metodi:<\/p>\n
          UnregisterFromPuship()<\/strong><\/p>\n
          UnregisterFromPuship(<\/strong>callbackSuccess)<\/strong><\/p>\n
          UnregisterFromPuship(<\/strong>callbackSuccess,<\/strong> callbackFail)<\/strong><\/p>\n
          Di seguito trovate un esempio:<\/p>\n\n\n
          <\/path><\/svg><\/div>
          Puship.UnregisterFromPuship( \n\tfunction() {\n\t\talert(\"success unregistered\");\n\t},\n\tfunction(err) {\n\t\talert(\"error: \"+ err);\n\t},\n);<\/pre><\/div>\n","protected":false},"excerpt":{"rendered":"
          Questa pagina documenta tutti i metodi comuni presenti nella libreria javascript del Puship-Plugin, questo significa che i metodi qui presenti sono compatibili con tutte le piattaforme e andranno a produrre gli stessi risultati. Tutti i metodi comuni si trovano all’interno della variabile Puship   Registrazione…<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":56,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":[],"_links":{"self":[{"href":"https:\/\/www.puship.com\/it\/wp-json\/wp\/v2\/pages\/15983\/"}],"collection":[{"href":"https:\/\/www.puship.com\/it\/wp-json\/wp\/v2\/pages\/"}],"about":[{"href":"https:\/\/www.puship.com\/it\/wp-json\/wp\/v2\/types\/page\/"}],"author":[{"embeddable":true,"href":"https:\/\/www.puship.com\/it\/wp-json\/wp\/v2\/users\/1\/"}],"replies":[{"embeddable":true,"href":"https:\/\/www.puship.com\/it\/wp-json\/wp\/v2\/comments\/?post=15983"}],"version-history":[{"count":48,"href":"https:\/\/www.puship.com\/it\/wp-json\/wp\/v2\/pages\/15983\/revisions\/"}],"predecessor-version":[{"id":18097,"href":"https:\/\/www.puship.com\/it\/wp-json\/wp\/v2\/pages\/15983\/revisions\/18097\/"}],"up":[{"embeddable":true,"href":"https:\/\/www.puship.com\/it\/wp-json\/wp\/v2\/pages\/56\/"}],"wp:attachment":[{"href":"https:\/\/www.puship.com\/it\/wp-json\/wp\/v2\/media\/?parent=15983"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}