Scalar types and definitions

[Cover] [Previous Section] [Next Section] [Index]

Current chapter: C++ Notification Library Reference
Section 32 out of 79 total sections , Section 2 out of 5 sections in this chapter

Scalar types and definitions

This section defines enumerated types and manifest constants used in the Notification API.

Notification types (ENtfnType)

The following enumerated constants specify notification types. See the UP.SDK Developer's Guide for a description of the notification types.

Constant	Description
`CNtfnTypePrefetch`	A prefetch notification; typically a digest to be preloaded into the UP.Phone cache.
`CNtfnTypeAlert`	An alert notification, which includes a brief message or header and a URL.
`CNtfnTypeCacheOp`	An alert notification, which includes a brief message or header and a URL.
`CNtfnTypeNone`	A dummy, invalid notification type, which you can use for catching errors.

Notification status codes (ENtfnStatus)

The following enumerated constants specify notification status codes returned by the UP.Link server in response to GetNtfnStatus(), GetPrefetchStatus(), and GetAlertStatus() calls..

Constant	Description
`CNtfnStatusPending`	Notification in process of being delivered
`CNtfnStatusDelivered`	Notification was delivered to phone
`CNtfnStatusExpired`	Notification expired (exceeded the notification's TTL)
`CNtfnStatusUndeliverable`	Notification could not be delivered
`CNtfnStatusNone`	A dummy, invalid status type, which you can use for catching errors.

Port numbers

The following constants specify the IANA-assigned port numbers for secure and non-secure notifications.

Constant	Description
`CUpnotifypsPort`	The `upnotifyps` (secure) port
`CUpnotifypPort`	The `upnotifyp` (non-secure) port

HTTP status codes

The following constants specify HTTP status codes. The meaning of these codes varies slightly depending on the context. For a detailed description of the meaning of each status code, see the "Returns" section for the methods described in Abstract base notification class (TNtfnClientAPI).

Constant	Description
`CHTTPStatusOK`	HTTP status code 200
`CHTTPStatusNoContent`	HTTP status code 204
`CHTTPStatusBadRequest`	HTTP status code 400
`CHTTPStatusForbidden`	HTTP status code 403
`CHTTPStatusNotFound`	HTTP status code 404
`CHTTPStatusSvcUnavail`	HTTP status code 503

IMPORTANT If a notification call returns a -1 error value, this indicates a general I/O failure has occured. The most common cause of this error is that a corporate firewall is blocking the destination notification port.

For more information on HTTP status codes, see the following RFC:

http://www.internic.net/rfc/rfc1945.txt

Notification protocols

The following constants specify the notification protocols used by the Notification API.

Constant	Description
`CNtfnProtoUpnotifyps`	`upnotifyps` (secure/HTTPS-based) protocol
`CNtfnProtoUpnotifyp`	`upnotifyp` (non-secure/HTTP-based) protocol
`CNtfnProtoNone`	Unknown protocol

Date buffer length constant

The API-defined constant CNtfnStatusDateBufLen specifies the required length (including the NULL terminator) of the buffers you specify for the postDate and dispositionDate arguments of the GetNtfnStatus(), GetPrefetchStatus(), GetAlertStatus() methods.

[Cover] [Previous Section] [Next Section] [Index]

Current chapter: C++ Notification Library Reference
Section 32 out of 79 total sections , Section 2 out of 5 sections in this chapter