AUDITEMAIL |
function auditEmail |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
customerKey |
Required |
numeric |
|
subjectKeyDescription |
Required |
string |
|
subjectKey |
Required |
numeric |
|
auditLogDescription |
Required |
string |
|
auditlogContent |
Required |
string |
|
emailSentTo |
Required |
string |
|
emailSentFrom |
Required |
string |
|
emailSentToCC |
Required |
string |
|
emailSentToBC |
Required |
string |
|
emailSubject |
Required |
string |
|
emailContent |
Required |
string |
|
mailServer |
Required |
string |
|
mailServerUsername |
Required |
string |
|
mailServerPassword |
Required |
string |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
This will add email to the log for auditing later. |
Description: |
|
|
|
AUTOLOGINROUTINE |
function autoLoginRoutine |
Arguments:
Name |
Required |
Type |
Default |
sessionUserKey |
Required |
numeric |
|
userSessionTracker |
Required |
string |
|
|
ReturnType: |
struct
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Process a user entry from another site. |
Description: |
|
|
|
BRIDGEAPPLICATIONENTRANCE |
function bridgeApplicationEntrance |
Arguments:
Name |
Required |
Type |
Default |
bridge |
Required |
string |
|
|
ReturnType: |
struct
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Process a user entry from another site. |
Description: |
|
|
|
CHECKAUTOLOGINSTATUS |
function checkAutoLoginStatus |
Arguments:
Name |
Required |
Type |
Default |
userSessionTracker |
Required |
string |
|
|
ReturnType: |
struct
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Process a user entry from another site. |
Description: |
|
|
|
CHECKAUTOLOGINSTATUSBYSESSIONUSERKEY |
function checkAutoLoginStatusBySessionUserKey |
Arguments:
Name |
Required |
Type |
Default |
sessionUserKey |
Required |
numeric |
|
|
ReturnType: |
struct
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
Process a user entry from another site. |
Description: |
|
|
|
CHECKPOINT |
function checkpoint |
Arguments:
Name |
Required |
Type |
Default |
checkpoint |
Required |
string |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
marks a checkpoint in the current request |
Description: |
|
|
|
CREATEAPPLICATIONPERMISSIONHASH |
function createapplicationPermissionHash |
Arguments:
Name |
Required |
Type |
Default |
applicationPermissionHashOBJ |
Required |
applicationPermissionHash |
|
|
ReturnType: |
applicationPermissionHash
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
CREATEAPPLICATIONPERMISSIONS |
function createApplicationPermissions |
Arguments:
Name |
Required |
Type |
Default |
applicationPermissionsOBJ |
Required |
applicationPermissions |
|
|
ReturnType: |
applicationPermissions
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
CREATECALENDARITEM |
function createCalendarItem |
Arguments:
Name |
Required |
Type |
Default |
CalendarItemOBJ |
Required |
CalendarItem |
|
|
ReturnType: |
CalendarItem
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
CREATECALENDARITEMCATEGORY |
function createCalendarItemCategory |
Arguments:
Name |
Required |
Type |
Default |
CalendarItemCategoryOBJ |
Required |
CalendarItemCategory |
|
|
ReturnType: |
CalendarItemCategory
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
CREATECATEGORIES |
function createcategories |
Arguments:
Name |
Required |
Type |
Default |
categoriesOBJ |
Required |
categories |
|
|
ReturnType: |
categories
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
CREATECATEGORYTYPES |
function createcategoryTypes |
Arguments:
Name |
Required |
Type |
Default |
categoryTypesOBJ |
Required |
categoryTypes |
|
|
ReturnType: |
categoryTypes
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
CREATECLIENTAPPEARANCES |
function createClientAppearances |
Arguments:
Name |
Required |
Type |
Default |
ClientAppearancesOBJ |
Required |
ClientAppearances |
|
|
ReturnType: |
ClientAppearances
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
DELETEAPPLICATIONPERMISSIONHASH |
function deleteapplicationPermissionHash |
Arguments:
Name |
Required |
Type |
Default |
applicationPermissionHashOBJ |
Required |
applicationPermissionHash |
|
|
ReturnType: |
boolean
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
DELETEAPPLICATIONPERMISSIONS |
function deleteapplicationPermissions |
Arguments:
Name |
Required |
Type |
Default |
applicationPermissionsOBJ |
Required |
applicationPermissions |
|
|
ReturnType: |
boolean
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
DELETECALENDARITEM |
function deleteCalendarItem |
Arguments:
Name |
Required |
Type |
Default |
calendarItemOBJ |
Required |
calendarItem |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
DELETECALENDARITEMCATEGORY |
function deleteCalendarItemCategory |
Arguments:
Name |
Required |
Type |
Default |
CalendarItemCategoryOBJ |
Required |
CalendarItemCategory |
|
|
ReturnType: |
boolean
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
DELETECATEGORIES |
function deletecategories |
Arguments:
Name |
Required |
Type |
Default |
categoriesOBJ |
Required |
categories |
|
|
ReturnType: |
boolean
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
DELETECATEGORY |
function deleteCategory |
Arguments:
Name |
Required |
Type |
Default |
categoryKey |
Required |
numeric |
|
|
ReturnType: |
boolean
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
DELETECATEGORYTYPES |
function deletecategoryTypes |
Arguments:
Name |
Required |
Type |
Default |
categoryTypesOBJ |
Required |
categoryTypes |
|
|
ReturnType: |
boolean
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
DELETECLIENTAPPEARANCES |
function deleteclientAppearances |
Arguments:
Name |
Required |
Type |
Default |
clientAppearancesOBJ |
Required |
clientAppearances |
|
|
ReturnType: |
boolean
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
DELETESUBCATEGORY |
function deleteSubCategory |
Arguments:
Name |
Required |
Type |
Default |
subcategoryKey |
Required |
numeric |
|
|
ReturnType: |
boolean
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETAD |
function getAd |
Arguments:
Name |
Required |
Type |
Default |
adKey |
Required |
numeric |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETADCONTENTFORLOCATIONKEY |
function getAdContentForLocationKey |
Arguments:
Name |
Required |
Type |
Default |
adLocationKey |
Required |
numeric |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETADMINBREADCRUMBDETAILLINKBYCATEGORYTYPEKEY |
function getAdminBreadCrumbDetailLinkByCategoryTypeKey |
Arguments:
Name |
Required |
Type |
Default |
categoryTypeKey |
Required |
numeric |
|
productKey |
Required |
numeric |
|
|
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETADMINBREADCRUMBRESULTSLINKBYCATEGORYTYPEKEY |
function getAdminBreadCrumbResultsLinkByCategoryTypeKey |
Arguments:
Name |
Required |
Type |
Default |
categoryTypeKey |
Required |
numeric |
|
|
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETADS |
function getAds |
Arguments:
Name |
Required |
Type |
Default |
adLocationKey |
Required |
numeric |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETADVERTISEMENTS |
function getAdvertisements |
Arguments: | none |
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETALLAPPLICATIONPERMISSIONS |
function getAllapplicationPermissions |
Arguments: | none |
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETALLBUSINESSLOCATIONCATEGORIESWITHSELECTEDINJSON |
function getAllBusinessLocationCategoriesWithSelectedInJSON |
Arguments:
Name |
Required |
Type |
Default |
businessLocationKey |
Required |
boolean |
|
|
ReturnType: |
string
|
Roles: |
|
Access: |
remote |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETALLCATEGORIES |
function getAllCategories |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETALLCATEGORIESBYCATEGORYTYPEINJSON |
function getAllCategoriesByCategoryTypeInJSON |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
categoryTypeKey |
Required |
numeric |
|
|
ReturnType: |
string
|
Roles: |
|
Access: |
remote |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETALLCATEGORIESFORADMIN |
function getAllCategoriesForAdmin |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETALLCATEGORIESINJSON |
function getAllCategoriesInJSON |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
forAdmin |
Optional |
boolean |
|
|
ReturnType: |
string
|
Roles: |
|
Access: |
remote |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETALLCATEGORYTYPES |
function getAllCategoryTypes |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETALLCATEGORYTYPESINJSON |
function getAllCategoryTypesInJSON |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
start |
Required |
numeric |
|
length |
Required |
numeric |
|
draw |
Required |
numeric |
|
searchTerm |
Required |
string |
|
orderColumn |
Required |
numeric |
|
orderDirection |
Required |
string |
|
|
ReturnType: |
string
|
Roles: |
|
Access: |
remote |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETALLCLIENTAPPEARANCES |
function getAllClientAppearances |
Arguments: | none |
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETALLCUSTOMERSCATEGORIESWITHSELECTEDINJSON |
function getAllCustomersCategoriesWithSelectedInJSON |
Arguments:
Name |
Required |
Type |
Default |
customerKey |
Required |
boolean |
|
|
ReturnType: |
string
|
Roles: |
|
Access: |
remote |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETAPPLICATIONPERMISSIONHASH |
function getapplicationPermissionHash |
Arguments:
Name |
Required |
Type |
Default |
key |
Required |
numeric |
|
|
ReturnType: |
applicationPermissionHash
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETAPPLICATIONPERMISSIONS |
function getapplicationPermissions |
Arguments:
Name |
Required |
Type |
Default |
key |
Required |
numeric |
|
|
ReturnType: |
applicationPermissions
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCALENDARCATEGORYCOLORS |
function getcalendarCategoryColors |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCALENDARITEM |
function getCalendarItem |
Arguments:
Name |
Required |
Type |
Default |
calendarItemKey |
Required |
numeric |
|
|
ReturnType: |
calendarItem
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCALENDARITEMCATEGORIES |
function getCalendarItemCategories |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
activeOnlyBit |
Required |
boolean |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCALENDARITEMCATEGORY |
function getCalendarItemCategory |
Arguments:
Name |
Required |
Type |
Default |
key |
Required |
numeric |
|
|
ReturnType: |
CalendarItemCategory
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCALENDARITEMDETAIL |
function getCalendarItemDetail |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
calendarItemKey |
Required |
numeric |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCALENDARITEMS |
function getCalendarItems |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
calendarCategoryKey |
Required |
numeric |
|
calendarTypeKey |
Required |
numeric |
|
activeOnlyBit |
Required |
boolean |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCALENDARITEMSBYDATERANGE |
function getCalendarItemsByDateRange |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
calendarCategoryKey |
Required |
numeric |
|
calendarTypeKey |
Required |
numeric |
|
startDate |
Required |
date |
|
endDate |
Required |
date |
|
activeOnlyBit |
Required |
boolean |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCALENDARITEMSINJSON |
function getCalendarItemsInJSON |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
calendarCategoryKey |
Required |
numeric |
|
start |
Required |
numeric |
|
length |
Required |
numeric |
|
draw |
Required |
numeric |
|
searchTerm |
Required |
string |
|
orderColumn |
Required |
numeric |
|
orderDirection |
Required |
string |
|
|
ReturnType: |
string
|
Roles: |
|
Access: |
remote |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCALENDARNUMBERS |
function getCalendarNumbers |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
activeOnlyBit |
Required |
boolean |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCALENDARRECURRINGSCHEDULES |
function getCalendarRecurringSchedules |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
calendarRecurringScheduleKey |
Required |
numeric |
|
activeOnlyBit |
Required |
boolean |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCALENDARSBYDATERANGE |
function getCalendarsByDateRange |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
categoryKey |
Required |
numeric |
|
startDate |
Required |
date |
|
endDate |
Required |
date |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCALENDARSINJSON |
function getCalendarsInJSON |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
start |
Required |
numeric |
|
length |
Required |
numeric |
|
draw |
Required |
numeric |
|
searchTerm |
Required |
string |
|
orderColumn |
Required |
numeric |
|
orderDirection |
Required |
string |
|
|
ReturnType: |
string
|
Roles: |
|
Access: |
remote |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCALENDARSTATUSES |
function getCalendarStatuses |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
activeOnlyBit |
Required |
boolean |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCALENDARTYPES |
function getCalendarTypes |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
activeOnlyBit |
Required |
boolean |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCATEGORIES |
function getcategories |
Arguments:
Name |
Required |
Type |
Default |
key |
Required |
numeric |
|
|
ReturnType: |
categories
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCATEGORIESASSIGNEDTOSUBJECT |
function getCategoriesAssignedToSubject |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
subjectKey |
Required |
numeric |
|
subjectTypeKey |
Required |
numeric |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCATEGORIESFORPRIMARYNAVIGATION |
function getCategoriesForPrimaryNavigation |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
subjectTypeKey |
Required |
numeric |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCATEGORIESPAGINATED_INJSON |
function getCategoriesPaginated_InJSON |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
start |
Required |
numeric |
|
length |
Required |
numeric |
|
draw |
Required |
numeric |
|
searchTerm |
Required |
string |
|
orderColumn |
Required |
numeric |
|
orderDirection |
Required |
string |
|
|
ReturnType: |
string
|
Roles: |
|
Access: |
remote |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCATEGORYBYKEY |
function getCategoryByKey |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
categoryKey |
Required |
numeric |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCATEGORYINJSON |
function getCategoryInJSON |
Arguments:
Name |
Required |
Type |
Default |
key |
Required |
numeric |
|
|
ReturnType: |
string
|
Roles: |
|
Access: |
remote |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCATEGORYNAMEBYKEY |
function getCategoryNameByKey |
Arguments:
Name |
Required |
Type |
Default |
categoryKey |
Required |
numeric |
|
|
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCATEGORYPAGESTYLES |
function getCategoryPageStyles |
Arguments:
Name |
Required |
Type |
Default |
categoryPageStyleKey |
Required |
numeric |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCATEGORYSUBCATEGORYDETAIL |
function getCategorySubCategoryDetail |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
categoryKey |
Required |
numeric |
|
subCategoryKey |
Required |
numeric |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCATEGORYSUBCATEGORYNAMEBYKEY |
function getCategorySubCategoryNameByKey |
Arguments:
Name |
Required |
Type |
Default |
categoryKey |
Required |
numeric |
|
subCategoryKey |
Required |
numeric |
|
|
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCATEGORYTYPENAMEBYKEY |
function getCategoryTypeNameByKey |
Arguments:
Name |
Required |
Type |
Default |
categoryTypeKey |
Required |
numeric |
|
|
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCATEGORYTYPES |
function getcategoryTypes |
Arguments:
Name |
Required |
Type |
Default |
key |
Required |
numeric |
|
|
ReturnType: |
categoryTypes
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCHECKPOINTS |
function getCheckpoints |
Arguments: | none |
ReturnType: |
array
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
returns the checkpoints saved for the current request |
Description: |
|
|
|
GETCLIENTAPPEARANCES |
function getclientAppearances |
Arguments:
Name |
Required |
Type |
Default |
key |
Required |
numeric |
|
|
ReturnType: |
clientAppearances
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETCLIENTAPPEARANCESBYKEY |
function getClientAppearancesByKey |
Arguments:
Name |
Required |
Type |
Default |
key |
Required |
numeric |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETEVENTSFORPUBLICCALENDAR |
function getEventsForPublicCalendar |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
categoryKey |
Required |
numeric |
|
start |
Required |
date |
|
end |
Required |
date |
|
|
ReturnType: |
string
|
Roles: |
|
Access: |
remote |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETPAGEANDARTICLESBYCLIENTFORDROPDOWN |
function getPageAndArticlesByClientForDropdown |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETSUBCATEGORIESPAGINATED_INJSON |
function getSubCategoriesPaginated_InJSON |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
categoryKey |
Required |
numeric |
|
start |
Required |
numeric |
|
length |
Required |
numeric |
|
draw |
Required |
numeric |
|
searchTerm |
Required |
string |
|
orderColumn |
Required |
numeric |
|
orderDirection |
Required |
string |
|
|
ReturnType: |
string
|
Roles: |
|
Access: |
remote |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETSUBCATEGORYBYKEY |
function getSubCategoryByKey |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
subCategoryKey |
Required |
numeric |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETSUBCATEGORYINJSON |
function getSubcategoryInJSON |
Arguments:
Name |
Required |
Type |
Default |
key |
Required |
numeric |
|
|
ReturnType: |
string
|
Roles: |
|
Access: |
remote |
Static: |
false |
Output: |
|
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
GETSUBCATEGORYNAMEBYKEY |
function getSubCategoryNameByKey |
Arguments:
Name |
Required |
Type |
Default |
subCategoryKey |
Required |
numeric |
|
|
ReturnType: |
string
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
INIT |
function init |
Arguments:
Name |
Required |
Type |
Default |
bugLogListener |
Required |
string |
|
bugEmailRecipients |
Optional |
string |
[empty string] |
bugEmailSender |
Optional |
string |
[empty string] |
hostname |
Optional |
string |
[empty string] |
apikey |
Optional |
string |
[empty string] |
appName |
Optional |
string |
[runtime expression] |
maxDumpDepth |
Optional |
numeric |
[runtime expression] |
writeToCFLog |
Optional |
boolean |
[runtime expression] |
sensitiveFieldNames |
Optional |
string |
[runtime expression] |
sanitizeExpressions |
Optional |
array |
[runtime expression] |
|
ReturnType: |
bugLogService
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
Constructor |
Description: |
|
|
|
INSERTADLOCATIONSDROPDOWN |
function insertAdLocationsDropdown |
Arguments:
Name |
Required |
Type |
Default |
fieldname |
Required |
string |
|
defaultKey |
Required |
numeric |
|
class |
Optional |
string |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
true |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
INSERTAPPLICATIONPERMISSIONSDROPDOWN |
function insertApplicationPermissionsDropdown |
Arguments:
Name |
Required |
Type |
Default |
fieldname |
Required |
string |
|
customerKey |
Required |
numeric |
|
class |
Optional |
string |
|
defaultValue |
Optional |
boolean |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
true |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
INSERTCATEGORYNAVIGATIONLINKTYPESDROPDOWN |
function insertCategoryNavigationLinkTypesDropdown |
Arguments:
Name |
Required |
Type |
Default |
fieldname |
Required |
string |
|
class |
Optional |
string |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
true |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
INSERTCHAINEDDROPDOWNSCATEGORYLINKTYPES |
function insertChainedDropdownsCategoryLinkTypes |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
linkPageOrArticleTypeKey |
Required |
numeric |
|
linkPageOrArticleKey |
Required |
numeric |
|
fieldnameOne |
Required |
string |
|
fieldnameTwo |
Required |
string |
|
|
ReturnType: |
struct
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
true |
DisplayName: |
|
Hint: |
Returns a Struct for the linked navigation option |
Description: |
|
|
|
INSERTCHAINEDDROPDOWNSSUBCATEGORYLINKTYPES |
function insertChainedDropdownsSubCategoryLinkTypes |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
linkPageOrArticleTypeKey |
Required |
numeric |
|
linkPageOrArticleKey |
Required |
numeric |
|
fieldnameOne |
Required |
string |
|
fieldnameTwo |
Required |
string |
|
|
ReturnType: |
struct
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
true |
DisplayName: |
|
Hint: |
Returns a Struct for the linked navigation option |
Description: |
|
|
|
MAINTAINCATEGORYNAVIGATIONCHANGES |
function maintainCategoryNavigationChanges |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
categoryTypeKey |
Required |
numeric |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
NOTIFYSERVICE |
function notifyService |
Arguments:
Name |
Required |
Type |
Default |
message |
Required |
string |
|
exception |
Optional |
any |
[runtime expression] |
extraInfo |
Optional |
any |
[empty string] |
severityCode |
Optional |
string |
[runtime expression] |
maxDumpDepth |
Optional |
numeric |
[runtime expression] |
writeToCFLog |
Optional |
boolean |
[runtime expression] |
AppName |
Optional |
string |
[runtime expression] |
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
Use this method to tell the bugTrackerService that an error has ocurred |
Description: |
|
|
|
SAVEAD |
function saveAd |
Arguments:
Name |
Required |
Type |
Default |
ADKEY |
Required |
numeric |
|
ADCONTENTADDITIONALCSS |
Required |
string |
|
ADCONTENTBACKGROUNDIMAGEFILENAME |
Required |
string |
|
ADCONTENTDESCRIPTION |
Required |
string |
|
ADCONTENTNAME |
Required |
string |
|
ADCONTENTURL |
Required |
string |
|
SECTIONHTML |
Required |
string |
|
ADCONTENTBACKGROUNDIMAGEOFFBIT |
Required |
boolean |
|
ADCONTENTISACTIVEBIT |
Required |
boolean |
|
ADCONTENTLOCATIONFK |
Required |
numeric |
|
SESSIONUSERKEY |
Required |
numeric |
|
EXISTINGIMAGE |
Required |
numeric |
|
adContentImageFileName |
Required |
string |
|
adContentImagePath |
Required |
string |
|
adContentDiskPath |
Required |
string |
|
|
ReturnType: |
query
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
UPDATEAPPLICATIONPERMISSIONHASH |
function updateapplicationPermissionHash |
Arguments:
Name |
Required |
Type |
Default |
applicationPermissionHashOBJ |
Required |
applicationPermissionHash |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
UPDATEAPPLICATIONPERMISSIONS |
function updateapplicationPermissions |
Arguments:
Name |
Required |
Type |
Default |
applicationPermissionsOBJ |
Required |
applicationPermissions |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
UPDATEBUSINESSLOCATIONCATEGORYHASH |
function updateBusinessLocationCategoryHash |
Arguments:
Name |
Required |
Type |
Default |
subjectKey |
Required |
numeric |
|
userKey |
Required |
numeric |
|
categoriesLIST |
Required |
string |
|
categorySubjectTypeFK |
Required |
numeric |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
UPDATECALENDARITEM |
function updateCalendarItem |
Arguments:
Name |
Required |
Type |
Default |
calendarItemOBJ |
Required |
calendarItem |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
UPDATECALENDARITEMCATEGORY |
function updateCalendarItemCategory |
Arguments:
Name |
Required |
Type |
Default |
CalendarItemCategoryOBJ |
Required |
CalendarItemCategory |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
UPDATECATEGORIES |
function updatecategories |
Arguments:
Name |
Required |
Type |
Default |
categoriesOBJ |
Required |
categories |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
UPDATECATEGORYHASH |
function updateCategoryHash |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
subjectKey |
Required |
numeric |
|
userKey |
Required |
numeric |
|
categoriesLIST |
Required |
string |
|
categorySubjectTypeFK |
Required |
numeric |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
UPDATECATEGORYTYPES |
function updatecategoryTypes |
Arguments:
Name |
Required |
Type |
Default |
categoryTypesOBJ |
Required |
categoryTypes |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
UPDATECLIENTAPPEARANCES |
function updateclientAppearances |
Arguments:
Name |
Required |
Type |
Default |
clientAppearancesOBJ |
Required |
clientAppearances |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
UPDATECLIENTCATEGORYTYPEPERMISSIONS |
function updateClientCategorytypePermissions |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
categoryTypeSelectedKeyLIST |
Required |
string |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
UPDATECUSTOMERCATEGORYHASH |
function updateCustomerCategoryHash |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
customerKey |
Required |
numeric |
|
categoriesLIST |
Required |
string |
|
categorySubjectTypeFK |
Required |
numeric |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|
UPDATECUSTOMERCATEGORYHASHWITHLIST |
function updateCustomerCategoryHashWithList |
Arguments:
Name |
Required |
Type |
Default |
clientKey |
Required |
numeric |
|
customerKey |
Required |
numeric |
|
categoriesLIST |
Required |
string |
|
categoryCategoryTypeFK |
Required |
numeric |
|
categorySubjectTypeFK |
Required |
numeric |
|
|
ReturnType: |
void
|
Roles: |
|
Access: |
public |
Static: |
false |
Output: |
false |
DisplayName: |
|
Hint: |
|
Description: |
|
|
|