Contentserv PHP API

CSCaraConst
in package

This file has the needed constants to be used in Cara

Tags
since

CS21.0

Table of Contents

ACTION_ACCEPTED  = 3
ACTION_DISMISSED  = 2
ACTION_READ  = 1
The available actions in the cara framework
ACTION_SHOWN  = 4
ACTIVE_SCRIPT_LAST_SYNC_DATE  = 'LastSyncDate'
ACTIVE_SCRIPT_PLUGIN_NOTIFICATION_SYNC_SCRIPT  = 'notificationsyncscript'
The internal plugin name for the synchronization between cs and the API gateway.
GATEWAY_DEV_URL  = 'https://dev.core.api.contentserv.com/v1/news/read'
Available Gateway configurations
GATEWAY_FIELD_CATEGORY  = 'category'
GATEWAY_FIELD_DESCRIPTION  = 'description'
GATEWAY_FIELD_ID  = 'id'
Available Gateway notification fields
GATEWAY_FIELD_LINK  = 'link'
GATEWAY_FIELD_PRODUCT  = 'product'
GATEWAY_FIELD_SERVICE  = 'service'
GATEWAY_FIELD_SERVICE_KEY  = 'key'
GATEWAY_FIELD_SERVICE_NAME  = 'name'
GATEWAY_FIELD_TITLE  = 'title'
GATEWAY_FIELD_VALID_FROM  = 'valid_from'
GATEWAY_FIELD_VALID_TO  = 'valid_to'
GATEWAY_FIELD_VERSIONS  = 'versions'
GATEWAY_PRESALES_URL  = 'https://prod.core.api.contentserv.com/v1/news/read'
GATEWAY_PROD_URL  = 'https://prod.core.api.contentserv.com/v1/news/read'
GATEWAY_SSL_CERT  = '/certs/auth_public.pem'
GATEWAY_SSL_KEY  = '/certs/auth_private.pem'
GATEWAY_TEST_URL  = 'https://stag.core.api.contentserv.com/v1/news/read'
MODULE_NAME  = 'cara'
The module name of the cara
OPTION_SHOW_NOTIFICATIONS  = 'ShowNotifications'
The available options/settings in the cara framework
RIGHT_CATEGORIES  = 'category:'
The internal rights name for the cara framework.
SMART_LIST_CHANNEL_CONTRIBUTION  = 2
SMART_LIST_CLASS_CONTRIBUTION  = 8
SMART_LIST_OBJECTTYPE_CONTRIBUTION  = 4
SMART_LIST_TASK_CONTRIBUTION  = 1
The available contributions for the SmartList.
VALUE_LIST_CATEGORIES_EXTERNAL_KEY  = 'CARA_NOTIFICATION_CATEGORIES'
VALUE_LIST_CATEGORIES_LABEL  = 'Categories'
The internal value list definition for the cara framework.
$SMART_LIST_CONTRIBUTIONS  : array<string|int, mixed>
Array variable that maps the available contributions and it's labels.

Constants

ACTION_ACCEPTED

public mixed ACTION_ACCEPTED = 3
Tags

ACTION_DISMISSED

public mixed ACTION_DISMISSED = 2
Tags

ACTION_READ

The available actions in the cara framework

public int ACTION_READ = 1
Tags

ACTIVE_SCRIPT_LAST_SYNC_DATE

public mixed ACTIVE_SCRIPT_LAST_SYNC_DATE = 'LastSyncDate'
Tags

ACTIVE_SCRIPT_PLUGIN_NOTIFICATION_SYNC_SCRIPT

The internal plugin name for the synchronization between cs and the API gateway.

public string ACTIVE_SCRIPT_PLUGIN_NOTIFICATION_SYNC_SCRIPT = 'notificationsyncscript'
Tags

GATEWAY_DEV_URL

Available Gateway configurations

public string GATEWAY_DEV_URL = 'https://dev.core.api.contentserv.com/v1/news/read'
Tags

GATEWAY_FIELD_CATEGORY

public mixed GATEWAY_FIELD_CATEGORY = 'category'
Tags

GATEWAY_FIELD_DESCRIPTION

public mixed GATEWAY_FIELD_DESCRIPTION = 'description'
Tags

GATEWAY_FIELD_ID

Available Gateway notification fields

public string GATEWAY_FIELD_ID = 'id'
Tags
public mixed GATEWAY_FIELD_LINK = 'link'
Tags

GATEWAY_FIELD_PRODUCT

public mixed GATEWAY_FIELD_PRODUCT = 'product'
Tags

GATEWAY_FIELD_SERVICE

public mixed GATEWAY_FIELD_SERVICE = 'service'
Tags

GATEWAY_FIELD_SERVICE_KEY

public mixed GATEWAY_FIELD_SERVICE_KEY = 'key'
Tags

GATEWAY_FIELD_SERVICE_NAME

public mixed GATEWAY_FIELD_SERVICE_NAME = 'name'
Tags

GATEWAY_FIELD_TITLE

public mixed GATEWAY_FIELD_TITLE = 'title'
Tags

GATEWAY_FIELD_VALID_FROM

public mixed GATEWAY_FIELD_VALID_FROM = 'valid_from'
Tags

GATEWAY_FIELD_VALID_TO

public mixed GATEWAY_FIELD_VALID_TO = 'valid_to'
Tags

GATEWAY_FIELD_VERSIONS

public mixed GATEWAY_FIELD_VERSIONS = 'versions'
Tags

GATEWAY_PRESALES_URL

public mixed GATEWAY_PRESALES_URL = 'https://prod.core.api.contentserv.com/v1/news/read'
Tags

GATEWAY_PROD_URL

public mixed GATEWAY_PROD_URL = 'https://prod.core.api.contentserv.com/v1/news/read'
Tags

GATEWAY_SSL_CERT

public mixed GATEWAY_SSL_CERT = '/certs/auth_public.pem'
Tags

GATEWAY_SSL_KEY

public mixed GATEWAY_SSL_KEY = '/certs/auth_private.pem'
Tags

GATEWAY_TEST_URL

public mixed GATEWAY_TEST_URL = 'https://stag.core.api.contentserv.com/v1/news/read'
Tags

MODULE_NAME

The module name of the cara

public string MODULE_NAME = 'cara'
Tags

OPTION_SHOW_NOTIFICATIONS

The available options/settings in the cara framework

public string OPTION_SHOW_NOTIFICATIONS = 'ShowNotifications'
Tags

RIGHT_CATEGORIES

The internal rights name for the cara framework.

public string RIGHT_CATEGORIES = 'category:'
Tags

SMART_LIST_CHANNEL_CONTRIBUTION

public mixed SMART_LIST_CHANNEL_CONTRIBUTION = 2
Tags

SMART_LIST_CLASS_CONTRIBUTION

public mixed SMART_LIST_CLASS_CONTRIBUTION = 8
Tags

SMART_LIST_OBJECTTYPE_CONTRIBUTION

public mixed SMART_LIST_OBJECTTYPE_CONTRIBUTION = 4
Tags

SMART_LIST_TASK_CONTRIBUTION

The available contributions for the SmartList.

public int SMART_LIST_TASK_CONTRIBUTION = 1
Tags

VALUE_LIST_CATEGORIES_EXTERNAL_KEY

public mixed VALUE_LIST_CATEGORIES_EXTERNAL_KEY = 'CARA_NOTIFICATION_CATEGORIES'
Tags

VALUE_LIST_CATEGORIES_LABEL

The internal value list definition for the cara framework.

public string VALUE_LIST_CATEGORIES_LABEL = 'Categories'
Tags

Properties

$SMART_LIST_CONTRIBUTIONS

Array variable that maps the available contributions and it's labels.

public static array<string|int, mixed> $SMART_LIST_CONTRIBUTIONS = array(self::SMART_LIST_TASK_CONTRIBUTION => 'CARA_SMART_LIST_TASK_CONTRIBUTION', self::SMART_LIST_CHANNEL_CONTRIBUTION => 'CARA_SMART_LIST_CHANNEL_CONTRIBUTION', self::SMART_LIST_OBJECTTYPE_CONTRIBUTION => 'CARA_SMART_LIST_OBJECTTYPE_CONTRIBUTION', self::SMART_LIST_CLASS_CONTRIBUTION => 'CARA_SMART_LIST_CLASS_CONTRIBUTION')
Tags

        

Search results