CSCaraApiNotification
in package
The CSCaraApiNotification is the Object API to manage notifications
Tags
Table of Contents
- LOCALE_DESCRIPTION_FIELD = 'Description'
- LOCALE_TITLE_FIELD = 'Title'
- __construct() : mixed
- CSCaraApiNotification constructor
- addDescription() : void
- Adds a description for the notification locales in the given language id
- addTitle() : void
- Adds a title for the notification locales in the given language id
- getCategory() : string
- Returns the category of the notification
- getDescription() : string
- Returns the "description" value for a given language
- getExternalId() : int
- Returns the external id of the notification
- getLink() : string|null
- Returns the link value
- getLocales() : array<string|int, mixed>
- Returns the notification locales
- getNotificationDate() : string
- Returns the "notification date" value
- getNotificationId() : int
- Returns the "NotificationId" value
- getProduct() : string
- Returns the product value
- getServiceKey() : string
- Returns the service key value
- getServiceName() : string
- Returns the service name value
- getTitle() : string
- Returns the "title" value for a given language
- getValidFrom() : string
- Returns the "valid from" value
- getValidTo() : string
- Returns the "valid to" value
- getVersions() : string
- Returns the versions value
- setCategory() : void
- Sets the category value
- setExternalId() : void
- Sets the external id value
- setLink() : void
- Sets the link value
- setNotificationDate() : void
- Sets the "notification date" value
- setProduct() : void
- Sets the product value
- setServiceKey() : void
- Sets the service key value
- setServiceName() : void
- Sets the service name value
- setValidFrom() : void
- Sets the "valid from" value
- setValidTo() : void
- Sets the "valid to" value
- setVersions() : void
- Sets the version value
Constants
LOCALE_DESCRIPTION_FIELD
public
mixed
LOCALE_DESCRIPTION_FIELD
= 'Description'
Tags
LOCALE_TITLE_FIELD
public
mixed
LOCALE_TITLE_FIELD
= 'Title'
Tags
Methods
__construct()
CSCaraApiNotification constructor
public
__construct(int $_iNotificationId) : mixed
Parameters
- $_iNotificationId : int
-
the id of the notification
Tags
Return values
mixed —addDescription()
Adds a description for the notification locales in the given language id
public
addDescription(string $sDescription, int $iLanguageId) : void
Parameters
- $sDescription : string
-
the description of the notification locale
- $iLanguageId : int
-
The id of the Language
Tags
Return values
void —addTitle()
Adds a title for the notification locales in the given language id
public
addTitle(string $sTitle, int $iLanguageId) : void
Parameters
- $sTitle : string
-
The title of the notification locale
- $iLanguageId : int
-
The id of the Language
Tags
Return values
void —getCategory()
Returns the category of the notification
public
getCategory() : string
Tags
Return values
string —getDescription()
Returns the "description" value for a given language
public
getDescription(mixed $iLanguageId) : string
Parameters
- $iLanguageId : mixed
-
int The language id to get the description for
Tags
Return values
string —getExternalId()
Returns the external id of the notification
public
getExternalId() : int
Tags
Return values
int —getLink()
Returns the link value
public
getLink() : string|null
Tags
Return values
string|null —getLocales()
Returns the notification locales
public
getLocales() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getNotificationDate()
Returns the "notification date" value
public
getNotificationDate() : string
Tags
Return values
string —getNotificationId()
Returns the "NotificationId" value
public
getNotificationId() : int
Tags
Return values
int —getProduct()
Returns the product value
public
getProduct() : string
Tags
Return values
string —getServiceKey()
Returns the service key value
public
getServiceKey() : string
Tags
Return values
string —getServiceName()
Returns the service name value
public
getServiceName() : string
Tags
Return values
string —getTitle()
Returns the "title" value for a given language
public
getTitle(mixed $iLanguageId) : string
Parameters
- $iLanguageId : mixed
-
int The language id to get the title for
Tags
Return values
string —getValidFrom()
Returns the "valid from" value
public
getValidFrom() : string
Tags
Return values
string —getValidTo()
Returns the "valid to" value
public
getValidTo() : string
Tags
Return values
string —getVersions()
Returns the versions value
public
getVersions() : string
Tags
Return values
string —setCategory()
Sets the category value
public
setCategory(mixed $sCategory) : void
Parameters
- $sCategory : mixed
-
string The category to be set
Tags
Return values
void —setExternalId()
Sets the external id value
public
setExternalId(mixed $iExternalId) : void
Parameters
- $iExternalId : mixed
-
string The external id to be set
Tags
Return values
void —setLink()
Sets the link value
public
setLink(mixed $sLink) : void
Parameters
- $sLink : mixed
-
string|null The link to be set
Tags
Return values
void —setNotificationDate()
Sets the "notification date" value
public
setNotificationDate(mixed $sNotificationDate) : void
Parameters
- $sNotificationDate : mixed
-
string The "notification date" to be set
Tags
Return values
void —setProduct()
Sets the product value
public
setProduct(mixed $sProduct) : void
Parameters
- $sProduct : mixed
-
string The product to be set
Tags
Return values
void —setServiceKey()
Sets the service key value
public
setServiceKey(mixed $sServiceKey) : void
Parameters
- $sServiceKey : mixed
-
string The service key to be set
Tags
Return values
void —setServiceName()
Sets the service name value
public
setServiceName(mixed $sServiceName) : void
Parameters
- $sServiceName : mixed
-
string The service name to be set
Tags
Return values
void —setValidFrom()
Sets the "valid from" value
public
setValidFrom(mixed $sValidFrom) : void
Parameters
- $sValidFrom : mixed
-
string The "valid from" to be set
Tags
Return values
void —setValidTo()
Sets the "valid to" value
public
setValidTo(mixed $sValidTo) : void
Parameters
- $sValidTo : mixed
-
string The "valid to" to be set
Tags
Return values
void —setVersions()
Sets the version value
public
setVersions(mixed $sVersions) : void
Parameters
- $sVersions : mixed
-
string The versions to be set