\notification_message

A base class notification message object. This is used to convey information that can be formatted and sent out via various transports.

This object is used to send data to various twitter, facebook, mail, and other modules. some transports may not use all of the fields or may aggregate the data in various ways.

Summary

Methods

Properties

Constants

valid_key()

$subject
$body
$module
$priority
$to
$to_group
$lat
$long
$html
$ischeckin
$link
$linkname
$caption
$description
$picture
$shorten

PRIORITY_HIGH
PRIORITY_NORMAL
PRIORITY_LOW

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: lib/class.notification_message.php
Package: CGExtensions
Class hierarchy: \notification_message
See also: \CGNotifier

Constants

PRIORITY_HIGH

PRIORITY_HIGH

PRIORITY_NORMAL

PRIORITY_NORMAL

PRIORITY_LOW

PRIORITY_LOW

Properties

$subject

$subject : string

The message subject

Type

string

$body

$body : string

The message body. Some distribution transports may strip HTML out of the body and/or shorten URLS or do other processing to make text compliant with their requirements.

Type

string

$module

$module : string

The name of the originationg module.

Type

string

$priority

$priority : \int/const

A message priority (1 = high, 2 = normal, 3 = low)

Type

\int/const

$to

$to : integer

A user identifier. A negative value indicates an admin user id. A positive value indicates an FEU uid.

Type

integer

$to_group

$to_group : integer

A group identifier. A negative value indicates an admin gid. A positive value indicates an FEU gid.

Type

integer

$lat

$lat : float

Latitude of sender

Type

float

$long

$long : float

Longitude of sender

Type

float

$html

$html : boolean

May indicate that the message is an HTML message. Some transports may ignore this.

Type

boolean

$ischeckin

$ischeckin : boolean

May indicate that the message is a user checkin.

Type

boolean

$link

$link : string

URL to attach to the message

Type

string

$linkname

$linkname : string

A name for the link

Type

string

$caption

$caption : string

A caption for the link

Type

string

$description

$description : string

A description for the link

Type

string

$picture

$picture : string

A URL to an image to attach to the message

Type

string

$shorten

$shorten : boolean

Indicates that URLS in the message body (and possibly the link and picture) can be shortened by the transport

Type

boolean

Methods

valid_key()

valid_key(string  $key) : boolean

Test if the key specified is valid

Parameters

string

$key

Returns

boolean