내보내기(0) 인쇄
모두 확장

apns 개체

업데이트 날짜: 2014년 10월

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 등록을 만듭니다.

매개 변수

Name Type 인수 설명

token

문자열

장치 토큰입니다.

tags

문자열 | 배열

단일 태그 또는 태그 배열(쉼표로 구분된 목록, 공백 없음)입니다.

options

개체

<옵션>

요청 옵션 또는 콜백 함수입니다.

callback

개체

<옵션>

successerror 콜백 함수를 지정하는 JSON 개체입니다.

createOrUpdateNativeRegistration(registrationId, token, tags, options, callback)
기본 APNS 등록을 만들거나 업데이트합니다.

매개 변수

Name Type 인수 설명

registrationId

문자열

등록 식별자입니다.

token

문자열

장치 토큰입니다.

tags

문자열 | 배열

단일 태그 또는 태그 배열(쉼표로 구분된 목록, 공백 없음)입니다.

options

개체

<옵션>

요청 옵션 또는 콜백 함수입니다.

callback

개체

<옵션>

successerror 콜백 함수를 지정하는 JSON 개체입니다.

createOrUpdateTemplateRegistration(registrationId, token, template, options, callback)
템플릿 등록을 만들거나 업데이트합니다.

매개 변수

Name Type 인수 설명

registrationId

문자열

등록 식별자입니다.

token

문자열

장치 토큰입니다.

template

문자열 | 배열

아래에 지정된 메시지의 JSON 페이로드입니다.

속성

Name Type 인수 설명

badge

번호

<옵션>

앱 아이콘 위에 표시할 번호입니다.

경고

문자열

<옵션>

경고 텍스트입니다.

sound

문자열

<옵션>

사운드 파일 이름입니다.

payload

개체

<옵션>

알림 텍스트를 포함하는 페이로드 개체입니다.

expiry

date

<옵션>

만료 날짜입니다.

페이로드가 문자열이면 APNS 형식을 따릅니다.

options

개체

<옵션>

요청 옵션 또는 콜백 함수입니다.

callback

개체

<옵션>

successerror 콜백 함수를 지정하는 JSON 개체입니다.

createTemplateRegistration(token, tags, template, options, callback)
템플릿 등록을 만듭니다.

매개 변수

Name Type 인수 설명

token

문자열

장치 토큰입니다.

tags

문자열 | 배열

단일 태그 또는 태그 배열(쉼표로 구분된 목록, 공백 없음)입니다.

template

문자열 | 배열

아래에 지정된 메시지의 JSON 페이로드입니다.

속성

Name Type 인수 설명

badge

번호

<옵션>

앱 아이콘 위에 표시할 번호입니다.

경고

문자열

<옵션>

경고 텍스트입니다.

sound

문자열

<옵션>

사운드 파일 이름입니다.

payload

개체

<옵션>

알림 텍스트를 포함하는 페이로드 개체입니다.

expiry

date

<옵션>

만료 날짜입니다.

페이로드가 문자열이면 APNS 형식을 따릅니다.

options

개체

<옵션>

요청 옵션 또는 콜백 함수입니다.

callback

개체

<옵션>

successerror 콜백 함수를 지정하는 JSON 개체입니다.

listRegistrationsByToken(token, options, callback)
장치 토큰으로 등록을 검색합니다.

매개 변수

Name Type 인수 설명

token

문자열

장치 토큰입니다.

options

개체

<옵션>

요청 옵션 또는 콜백 함수입니다. 추가 속성이 헤더로 전달됩니다.

속성

Name Type 인수 설명

top

개체

<옵션>

호출에서 가져올 최대 등록 수를 지정합니다.

skip

개체

<옵션>

호출에서 건너뛸 등록 수를 지정합니다.

callback

개체

<옵션>

successerror 콜백 함수를 지정하는 JSON 개체입니다.

send(tags, payload, callback)
APNS 알림을 보냅니다.

매개 변수

Name Type 설명

tags

문자열

단일 태그 또는 태그 식입니다. Null이면 모든 템플릿 등록에 메시지가 전송됩니다.

payload

개체 | 문자열

아래에 지정된 메시지의 JSON 페이로드입니다.

속성

Name Type 인수 설명

badge

번호

<옵션>

앱 아이콘 위에 표시할 번호입니다.

경고

문자열

<옵션>

경고 텍스트입니다.

sound

문자열

<옵션>

사운드 파일 이름입니다.

payload

개체

<옵션>

알림 텍스트를 포함하는 페이로드 개체입니다.

expiry

date

<옵션>

만료 날짜입니다.

페이로드가 문자열이면 APNS 형식을 따릅니다.

callback

개체

successerror 콜백 함수를 지정하는 JSON 개체입니다.

updateTemplateRegistration(registrationId, token, template, options, callback)
기존 템플릿 등록을 업데이트합니다.

매개 변수

Name Type 인수 설명

registrationId

문자열

등록 식별자입니다.

token

문자열

장치 토큰입니다.

template

문자열 | 배열

아래에 지정된 메시지의 JSON 페이로드입니다.

속성

Name Type 인수 설명

badge

번호

<옵션>

앱 아이콘 위에 표시할 번호입니다.

경고

문자열

<옵션>

경고 텍스트입니다.

sound

문자열

<옵션>

사운드 파일 이름입니다.

payload

개체

<옵션>

알림 텍스트를 포함하는 페이로드 개체입니다.

expiry

date

<옵션>

만료 날짜입니다.

페이로드가 문자열이면 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 + "'"
        }
    });
}

Microsoft는 MSDN 웹 사이트에 대한 귀하의 의견을 이해하기 위해 온라인 설문 조사를 진행하고 있습니다. 참여하도록 선택하시면 MSDN 웹 사이트에서 나가실 때 온라인 설문 조사가 표시됩니다.

참여하시겠습니까?
표시:
© 2014 Microsoft