本頁是否能提供幫助?
您對此內容的意見反應十分重要。 請告訴我們您的想法。
其他意見反應?
剩餘 1500 個字元
apns 物件

apns 物件

更新日期: 2015年6月

可讓您使用 Azure 通知中樞,從 Microsoft Azure 行動服務 伺服器指令碼將推播通知傳送至 iOS 應用程式。APNS 通知的裝載具有下列 JSON 格式:

{
    aps: {
        badge: badge_number,
        alert: 'alert_text',
        sound: 'sound_file',
        payload: payload_object,
        expiry: expire_date
    }
}

createNativeRegistration(token, tags, options, callback)
建立原生 APNS 註冊。

參數

名稱 型別 引數 描述

token

字串

裝置權杖。

tags

字串 | 陣列

單一標記或標記的陣列 (以逗號分隔的清單,不含空格)。

options

物件

<選用>

要求選項或回呼函數。

callback

物件

<選用>

一個指定 successerror 回呼函數的 JSON 物件。

createOrUpdateNativeRegistration(registrationId, token, tags, options, callback)
建立或更新原生 APNS 註冊。

參數

名稱 型別 引數 描述

registrationId

字串

註冊識別碼。

token

字串

裝置權杖。

tags

字串 | 陣列

單一標記或標記的陣列 (以逗號分隔的清單,不含空格)。

options

物件

<選用>

要求選項或回呼函數。

callback

物件

<選用>

一個指定 successerror 回呼函數的 JSON 物件。

createOrUpdateTemplateRegistration(registrationId, token, template, options, callback)
建立或更新範本註冊。

參數

名稱 型別 引數 描述

registrationId

字串

註冊識別碼。

token

字串

裝置權杖。

template

字串 | 陣列

訊息的 JSON 裝載指定如下。

屬性

名稱 型別 引數 描述

badge

number

<選用>

要在應用程式圖示上顯示的數值。

警示

字串

<選用>

警示文字。

sound

字串

<選用>

音效檔名稱。

payload

物件

<選用>

包含通知文字的裝載物件。

expiry

日期

<選用>

到期日。

當裝載為字串時,採用 APNS 格式。

options

物件

<選用>

要求選項或回呼函數。

callback

物件

<選用>

一個指定 successerror 回呼函數的 JSON 物件。

createTemplateRegistration(token, tags, template, options, callback)
建立範本註冊。

參數

名稱 型別 引數 描述

token

字串

裝置權杖。

tags

字串 | 陣列

單一標記或標記的陣列 (以逗號分隔的清單,不含空格)。

template

字串 | 陣列

訊息的 JSON 裝載指定如下。

屬性

名稱 型別 引數 描述

badge

number

<選用>

要在應用程式圖示上顯示的數值。

警示

字串

<選用>

警示文字。

sound

字串

<選用>

音效檔名稱。

payload

物件

<選用>

包含通知文字的裝載物件。

expiry

日期

<選用>

到期日。

當裝載為字串時,採用 APNS 格式 格式。

options

物件

<選用>

要求選項或回呼函數。

callback

物件

<選用>

一個指定 successerror 回呼函數的 JSON 物件。

listRegistrationsByToken(token, options, callback)
依裝置權杖擷取註冊。

參數

名稱 型別 引數 描述

token

字串

裝置權杖。

options

物件

<選用>

要求選項或回呼函數。其他屬性會傳入作為標頭。

屬性

名稱 型別 引數 描述

top

物件

<選用>

指定要從呼叫中取得的最大註冊數目。

skip

物件

<選用>

指定要在呼叫中略過的註冊數目。

callback

物件

<選用>

一個指定 successerror 回呼函數的 JSON 物件。

send(tags, payload, callback)
傳送 APNS 通知。

參數

名稱 型別 描述

tags

字串

單一標記或標記運算式。如果為 null,則訊息會傳送至所有範本註冊。

payload

物件 | 字串

訊息的 JSON 裝載指定如下。

屬性

名稱 型別 引數 描述

badge

number

<選用>

要在應用程式圖示上顯示的數值。

警示

字串

<選用>

警示文字。

sound

字串

<選用>

音效檔名稱。

payload

物件

<選用>

包含通知文字的裝載物件。

expiry

日期

<選用>

到期日。

當裝載為字串時,採用 APNS 格式 格式。

callback

物件

一個指定 successerror 回呼函數的 JSON 物件。

updateTemplateRegistration(registrationId, token, template, options, callback)
更新現有的範本註冊。

參數

名稱 型別 引數 描述

registrationId

字串

註冊識別碼。

token

字串

裝置權杖。

template

字串 | 陣列

訊息的 JSON 裝載指定如下。

屬性

名稱 型別 引數 描述

badge

number

<選用>

要在應用程式圖示上顯示的數值。

警示

字串

<選用>

警示文字。

sound

字串

<選用>

音效檔名稱。

payload

物件

<選用>

包含通知文字的裝載物件。

expiry

日期

<選用>

到期日。

當裝載為字串時,採用 APNS 格式 格式。

options

物件

<選用>

要求選項。

callback

物件

一個指定 successerror 回呼函數的 JSON 物件。

如需如何將推播通知從您的行動服務傳送至 iOS 應用程式的範例,請參閱<開始在行動服務中使用推播通知>。

apns 物件是從伺服器指令碼中的 push 物件取得。如需完整範例,請參閱<開始使用推送通知>。

APNS 通知的裝載具有下列 JSON 格式:

{
    aps: {
        badge: badge_number,
        alert: 'alert_text',
        sound: 'sound_file',
        payload: payload_object,
        expiry: expire_date
    }
}

當指定 payload 物件的 alert 欄位時,指派的文字值會顯示為快顯通知。即使應用程式未執行,此通知仍會顯示。當應用程式正在執行時,則只會顯示 payload 物件的 payload 欄位中的資料。

下列範例會呼叫 send 方法,在新的項目插入資料表時,傳送文字通知給特定的裝置。

function insert(item, user, request) {
    request.execute();
    push.apns.send(null, {
        alert: "Alert: " + item.text,
        payload: {
            inAppMessage: "Hey, a new item arrived: '" + item.text + "'"
        }
    });
}

顯示:
© 2015 Microsoft