# \notification_message

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

This object is used to send data to various twitter, facebook, mail, and other modules. some channels 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
$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

## Tags

todo |

## Constants

### PRIORITY_HIGH

    PRIORITY_HIGH

#

## Tags

todo |

### PRIORITY_NORMAL

    PRIORITY_NORMAL

#

## Tags

todo |

### PRIORITY_LOW

    PRIORITY_LOW

#

## Tags

todo |

## Properties

### $subject

    $subject : string

The message subject

#### Type

string

#

## Tags

None found

### $body

    $body : string

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

#### Type

string

#

## Tags

None found

### $module

    $module : string

The name of the originationg module.

#### Type

string

#

## Tags

None found

### $priority

    $priority : \int/const

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

#### Type

\int/const

#

## Tags

None found

### $to

    $to : int

A user identifier

#### Type

int

#

## Tags

None found

### $lat

    $lat : float

Latitude of sender

#### Type

float

#

## Tags

None found

### $long

    $long : float

Longitude of sender

#### Type

float

#

## Tags

None found

### $html

    $html : bool

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

#### Type

bool

#

## Tags

None found

### $ischeckin

    $ischeckin : bool

May indicate that the message is a user checkin.

#### Type

bool

#

## Tags

None found

### $link

    $link : string

URL to attach to the message

#### Type

string

#

## Tags

None found

### $linkname

    $linkname : string

A name for the link

#### Type

string

#

## Tags

None found

### $caption

    $caption : string

A caption for the link

#### Type

string

#

## Tags

None found

### $description

    $description : string

A description for the link

#### Type

string

#

## Tags

None found

### $picture

    $picture : string

A URL to an image to attach to the message

#### Type

string

#

## Tags

None found

### $shorten

    $shorten : bool

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

#### Type

bool

#

## Tags

None found

## Methods

### valid_key()

    valid_key(string $key) : bool

Test if the key specified is valid

#### Parameters

string | $key |

#### Returns

bool

#

## Tags

todo |

### class.notification_message.php