| struct |
| adimagediskpath |
E:\WEB\mightecontent.com.v3\assets\custom\img\ads\2\
|
| adimageurlpath |
https://beta.mightecontent.com/assets/custom/img/ads/2/
|
| adminorderloggingonbit |
1
|
| admoduleisonbit |
1
|
| adsservice |
| [cfc1] component
components.ads.adsService
|
| METHODS |
| 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: |
|
|
|
| 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: |
|
|
|
| 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: |
|
|
|
| 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: |
|
|
|
|
|
| appearanceimagediskpath |
E:\WEB\mightecontent.com.v3\assets\custom\img\appearance\2\
|
| appearanceimagethumbnaildiskpath |
E:\WEB\mightecontent.com.v3\assets\custom\img\appearanceThumbs\2\
|
| appearanceimagethumbnailurlpath |
https://beta.mightecontent.com/assets/custom/img/appearanceThumbs/2/
|
| appearanceimageurlpath |
https://beta.mightecontent.com/assets/custom/img/appearance/2/
|
| applicationisstagingorproduction |
1
|
| applicationkey |
7
|
| applicationloggingonbit |
1
|
| applicationname |
MECM-beta.mightecontent.com
|
| applicationnameprefix |
MECM-
|
| applicationpermissionsdao |
| [cfc2] component
components.permissions.applicationPermissionsDAO
|
| METHODS |
| CREATEAPPLICATIONPERMISSIONS |
| function createApplicationPermissions |
Arguments:
| Name |
Required |
Type |
Default |
| applicationPermissionsOBJ |
Required |
applicationPermissions |
|
|
| ReturnType: |
applicationPermissions
|
| 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: |
|
|
|
| GETAPPLICATIONPERMISSIONS |
| function getapplicationPermissions |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
applicationPermissions
|
| 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: |
|
|
|
|
|
| applicationpermissionshashdao |
| [cfc3] component
components.permissions.applicationPermissionsHashDAO
|
| METHODS |
| CREATEAPPLICATIONPERMISSIONHASH |
| function createapplicationPermissionHash |
Arguments:
| Name |
Required |
Type |
Default |
| applicationPermissionHashOBJ |
Required |
applicationPermissionHash |
|
|
| ReturnType: |
applicationPermissionHash
|
| 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: |
|
|
|
| GETAPPLICATIONPERMISSIONHASH |
| function getapplicationPermissionHash |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
applicationPermissionHash
|
| 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: |
|
|
|
|
|
| applicationpermissionsservice |
| [cfc4] component
components.permissions.applicationPermissionsService
|
| METHODS |
| GETALLAPPLICATIONPERMISSIONS |
| function getAllapplicationPermissions |
| Arguments: | none |
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| 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: |
|
|
|
|
|
| applicationstatedatasource |
applicationStateServer
|
| appstatemanagementloggingonbit |
1
|
| audit |
| [cfc5] component
components.audit.audit
|
| METHODS |
| 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: |
|
|
|
|
|
| autologinmanager |
| [cfc6] component
components.sessionManagement.autoLoginManager
|
| METHODS |
| 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: |
|
|
|
|
|
| basediskpath |
E:\WEB\mightecontent.com.v3\
|
| baseurl |
https://beta.mightecontent.com
|
| bugapplicationname |
MightEContent-Demo
|
| buglogmaximumstructdepth |
10
|
| buglogservice |
| [cfc7] component
components.commonFunctions.bugLogService
|
| METHODS |
| 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: |
|
|
|
| GETCHECKPOINTS |
| function getCheckpoints |
| Arguments: | none |
| ReturnType: |
array
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
returns the checkpoints saved for the current request |
| 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: |
|
|
|
| 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: |
|
|
|
|
|
| buglogwritetocflog |
1
|
| calendaritemcategorydao |
| [cfc8] component
components.calendars.calendarItemCategoryDAO
|
| METHODS |
| CREATECALENDARITEMCATEGORY |
| function createCalendarItemCategory |
Arguments:
| Name |
Required |
Type |
Default |
| CalendarItemCategoryOBJ |
Required |
CalendarItemCategory |
|
|
| ReturnType: |
CalendarItemCategory
|
| 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: |
|
|
|
| GETCALENDARITEMCATEGORY |
| function getCalendarItemCategory |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
CalendarItemCategory
|
| 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: |
|
|
|
|
|
| calendaritemdao |
| [cfc9] component
components.calendars.calendarItemDAO
|
| METHODS |
| CREATECALENDARITEM |
| function createCalendarItem |
Arguments:
| Name |
Required |
Type |
Default |
| CalendarItemOBJ |
Required |
CalendarItem |
|
|
| ReturnType: |
CalendarItem
|
| 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: |
|
|
|
| GETCALENDARITEM |
| function getCalendarItem |
Arguments:
| Name |
Required |
Type |
Default |
| calendarItemKey |
Required |
numeric |
|
|
| ReturnType: |
calendarItem
|
| 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: |
|
|
|
|
|
| calendaritemservice |
| [cfc10] component
components.calendars.calendarItemService
|
| METHODS |
| GETCALENDARCATEGORYCOLORS |
| function getcalendarCategoryColors |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| 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: |
|
|
|
| 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: |
|
|
|
| GETCALENDARSBYDATERANGEFROMMIGHTEVENT |
| function getCalendarsByDateRangeFromMightEvent |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
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: |
|
|
|
| GETEVENTSFORPUBLICCALENDAR |
| function getEventsForPublicCalendar |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
| start |
Required |
string |
|
| end |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETEVENTSFORPUBLICCALENDARFROMMIGHTEVENT |
| function getEventsForPublicCalendarFromMightEvent |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| start |
Required |
string |
|
| end |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| careercenterdiskpath |
E:\WEB\mightecontent.com.v3\downloads\resources\career-center\2\
|
| careercenterurlpath |
/downloads/resources/career-center/2/
|
| cartloggingonbit |
1
|
| categoriesdao |
| [cfc11] component
components.categories.categoriesDAO
|
| METHODS |
| CREATECATEGORIES |
| function createcategories |
Arguments:
| Name |
Required |
Type |
Default |
| categoriesOBJ |
Required |
categories |
|
|
| ReturnType: |
categories
|
| 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: |
|
|
|
| GETCATEGORIES |
| function getcategories |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
categories
|
| 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: |
|
|
|
|
|
| categoriesservice |
| [cfc12] component
components.categories.categoriesService
|
| METHODS |
| DELETECATEGORY |
| function deleteCategory |
Arguments:
| Name |
Required |
Type |
Default |
| categoryKey |
Required |
numeric |
|
|
| 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: |
|
|
|
| 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: |
|
|
|
| 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: |
|
|
|
| GETALLCUSTOMERSCATEGORIESWITHSELECTEDINJSON |
| function getAllCustomersCategoriesWithSelectedInJSON |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
boolean |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| 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: |
|
|
|
| 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: |
|
|
|
| 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: |
|
|
|
| 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: |
|
|
|
| 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: |
|
|
|
| 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: |
|
|
|
|
|
| categorytypesdao |
| [cfc13] component
components.categories.categoryTypesDAO
|
| METHODS |
| CREATECATEGORYTYPES |
| function createcategoryTypes |
Arguments:
| Name |
Required |
Type |
Default |
| categoryTypesOBJ |
Required |
categoryTypes |
|
|
| ReturnType: |
categoryTypes
|
| 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: |
|
|
|
| GETCATEGORYTYPES |
| function getcategoryTypes |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
categoryTypes
|
| 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: |
|
|
|
|
|
| cfcloggingonbit |
1
|
| checkoutloggingonbit |
1
|
| clientappearancesdao |
| [cfc14] component
components.clients.clientAppearancesDAO
|
| METHODS |
| CREATECLIENTAPPEARANCES |
| function createClientAppearances |
Arguments:
| Name |
Required |
Type |
Default |
| ClientAppearancesOBJ |
Required |
ClientAppearances |
|
|
| ReturnType: |
ClientAppearances
|
| 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: |
|
|
|
| GETCLIENTAPPEARANCES |
| function getclientAppearances |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
clientAppearances
|
| 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: |
|
|
|
|
|
| clientappearancesgateway |
| [cfc15] component
components.clients.clientAppearancesGateway
|
| METHODS |
| GETALLCLIENTAPPEARANCES |
| function getAllClientAppearances |
| Arguments: | none |
| ReturnType: |
query
|
| 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: |
|
|
|
|
|
| clientappearancesservice |
| [cfc16] component
components.clients.clientAppearancesService
|
| METHODS |
| GETCLIENTAPPEARANCEKEYBYCLIENTKEY |
| function getClientAppearanceKeyByClientKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCLIENTAPPEARANCESBYKEY |
| function getClientAppearancesByKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCLIENTFOOTERAPPEARANCE |
| function getClientFooterAppearance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCLIENTSOCIALMEDIA |
| function getClientSocialMedia |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCLIENTWELCOMEEMAILCONTENTBYKEY |
| function getClientWelcomeEmailContentByKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| clientbusinesshoursdao |
| [cfc17] component
components.clients.clientBusinessHoursDAO
|
| METHODS |
| CREATECLIENTBUSINESSHOURS |
| function createClientBusinessHours |
Arguments:
| Name |
Required |
Type |
Default |
| clientBusinessHoursOBJ |
Required |
clientBusinessHours |
|
|
| ReturnType: |
clientBusinessHours
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETECLIENTBUSINESSHOURS |
| function deleteclientBusinessHours |
Arguments:
| Name |
Required |
Type |
Default |
| clientBusinessHoursOBJ |
Required |
clientBusinessHours |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCLIENTBUSINESSHOURS |
| function getclientBusinessHours |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
clientBusinessHours
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATECLIENTBUSINESSHOURS |
| function updateclientBusinessHours |
Arguments:
| Name |
Required |
Type |
Default |
| clientBusinessHoursOBJ |
Required |
clientBusinessHours |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| clientbusinesshoursservice |
| [cfc18] component
components.clients.clientBusinessHoursService
|
| METHODS |
| GETCLIENTBUSINESSHOURSBYCLIENTKEY |
| function getClientBusinessHoursByClientKey |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCLIENTBUSINESSHOURSBYCLIENTKEYFORDISPLAY |
| function getClientBusinessHoursByClientKeyForDisplay |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| clientfeaturesdao |
| [cfc19] component
components.clients.clientFeaturesDAO
|
| METHODS |
| CREATECLIENTAPPLICATIONFEATURES |
| function createclientApplicationFeatures |
Arguments:
| Name |
Required |
Type |
Default |
| clientApplicationFeaturesOBJ |
Required |
clientFeatures |
|
|
| ReturnType: |
clientFeatures
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETECLIENTAPPLICATIONFEATURES |
| function deleteclientApplicationFeatures |
Arguments:
| Name |
Required |
Type |
Default |
| clientApplicationFeaturesOBJ |
Required |
clientFeatures |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCLIENTAPPLICATIONFEATURES |
| function getclientApplicationFeatures |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
clientFeatures
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATECLIENTAPPLICATIONFEATURES |
| function updateclientApplicationFeatures |
Arguments:
| Name |
Required |
Type |
Default |
| clientApplicationFeaturesOBJ |
Required |
clientFeatures |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| clientfeaturesservice |
| [cfc20] component
components.clients.clientFeaturesService
|
| METHODS |
| GETALLCLIENTAPPLICATIONFEATURES |
| function getAllClientApplicationFeatures |
| Arguments: | none |
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCLIENTAPPLICATIONFEATURES |
| function getClientApplicationFeatures |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCLIENTAPPLICATIONFEATURESBYKEY |
| function getClientApplicationFeaturesByKey |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| MAINTAINCLIENTAPPLICATIONFEATURES |
| function maintainClientApplicationFeatures |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| clientApplicationFeaturesFaqIsOn |
Required |
boolean |
|
| clientApplicationFeaturesDownloadsIsOn |
Required |
boolean |
|
| clientApplicationFeaturesPOIIsOn |
Required |
boolean |
|
| clientApplicationFeaturesTestimonialIsOn |
Required |
boolean |
|
| clientApplicationFeaturesConferenceIsOn |
Required |
boolean |
|
| clientApplicationFeaturesCareerCenterIsOn |
Required |
boolean |
|
| clientApplicationFeaturesPhotoGalleyIsOn |
Required |
boolean |
|
| clientApplicationFeaturesSharedDocumentIsOn |
Required |
boolean |
|
| clientApplicationFeaturesCalendarIsOn |
Required |
boolean |
|
| clientApplicationFeaturesEventDisplayIsOn |
Required |
boolean |
|
| clientApplicationFeaturesGoogleAnalyticsCode |
Required |
string |
|
| clientApplicationFeaturesGoogleAnalyticsAccountNumber |
Required |
string |
|
| clientApplicationFeaturesGoogleAnalytics4Code |
Required |
string |
|
| clientApplicationFeaturesGoogleAnalytics4AccountNumber |
Required |
string |
|
| clientApplicationFeaturesGoogleTagManagerHeadCode |
Required |
string |
|
| clientApplicationFeaturesGoogleTagManagerBodyCode |
Required |
string |
|
| clientApplicationFeaturesAdManagerIsOn |
Required |
boolean |
|
| sessionUserKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| clientkey |
2
|
| clientnewsfeednumberofrowsforpaginatedpage |
10
|
| clientnewsfeednumberofrowsforstandardpage |
10
|
| clientsdao |
| [cfc21] component
components.clients.clientsDAO
|
| METHODS |
| DELETECLIENTS |
| function deleteClients |
Arguments:
| Name |
Required |
Type |
Default |
| ClientsOBJ |
Required |
Clients |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCLIENTS |
| function getClients |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
Clients
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATECLIENTS |
| function updateClients |
Arguments:
| Name |
Required |
Type |
Default |
| ClientsOBJ |
Required |
Clients |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| clientspecificservice |
| [cfc22] component
components.clients.clientSpecificService
|
| METHODS |
| GETFOLDERSBYCATEGORYKEY |
| function getFoldersByCategoryKey |
Arguments:
| Name |
Required |
Type |
Default |
| customerTypeKey |
Required |
numeric |
|
| categoryTypeKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETFOLDERSTRUCTURE |
| function getFolderStructure |
Arguments:
| Name |
Required |
Type |
Default |
| customerTypeKey |
Required |
numeric |
|
| categoryTypeKey |
Required |
numeric |
|
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETUSERBASEFOLDERS |
| function getUserBaseFolders |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
| categoryTypeKey |
Required |
numeric |
|
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| clientsservice |
| [cfc23] component
components.clients.clientsService
|
| METHODS |
| CHECKPOINTOFINTERESTADDRESS |
| function checkPointOfInterestAddress |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATECLIENTBANNERIMAGE |
| function createClientBannerImage |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| userKey |
Required |
numeric |
|
| largeFileName |
Required |
string |
|
| thumbnailFileName |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATENEWCLIENT |
| function createNewClient |
Arguments:
| Name |
Required |
Type |
Default |
| ClientsOBJ |
Required |
Clients |
|
|
| ReturnType: |
Clients
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETALLACTIVECLIENTS |
| function getAllActiveClients |
| Arguments: | none |
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETALLCLIENTS |
| function getAllClients |
Arguments:
| Name |
Required |
Type |
Default |
| 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: |
|
|
|
| GETALLCLIENTSBUTTHISONE |
| function getAllClientsButThisOne |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETALLCLIENTSWITHCOUNT |
| function getAllclientsWithCount |
| Arguments: | none |
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETALLSUBCLIENTS |
| function getAllSubClients |
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: |
|
|
|
| GETCLIENTAPPLICATIONFEATUREPERMISSIONS |
| function getClientApplicationFeaturePermissions |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCLIENTFEATURESETTINGS |
| function getClientFeatureSettings |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCLIENTMAILSERVERSETTINGS |
| function getClientMailServerSettings |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCLIENTPAYMENTPROCESSINGINFORMATION |
| function getClientPaymentProcessingInformation |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCLIENTSBYKEY |
| function getClientsByKey |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMPAGEBYPAGEKEY |
| function getCustomPageByPageKey |
Arguments:
| Name |
Required |
Type |
Default |
| customPageKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| RUNCREATENEWCLIENTROUTINE |
| function runCreateNewClientRoutine |
Arguments:
| Name |
Required |
Type |
Default |
| ClientsOBJ |
Required |
Clients |
|
|
| ReturnType: |
Clients
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| RUNCREATENEWSUBCLIENTROUTINE |
| function runCreateNewSubClientRoutine |
Arguments:
| Name |
Required |
Type |
Default |
| ClientsOBJ |
Required |
Clients |
|
|
| ReturnType: |
Clients
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEAPPLICATIONNAME |
| function updateApplicationName |
Arguments:
| Name |
Required |
Type |
Default |
| clientObj |
Required |
Clients |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| clienttwitterhandle |
msmilonich
|
| clienttwitterid |
371749460432285696
|
| commonfunctions |
| [cfc24] component
components.commonFunctions.commonFunctions
|
| METHODS |
| CHECKFORPOPUPS |
| function checkForPopups |
Arguments:
| Name |
Required |
Type |
Default |
| pageURLPath |
Required |
string |
|
| popupsDisplayed |
Required |
string |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATEPOPUP |
| function createPopup |
Arguments:
| Name |
Required |
Type |
Default |
| popupName |
Optional |
string |
|
| popupContent |
Optional |
string |
|
| popupLocationFK |
Required |
numeric |
|
| popupStartDate |
Optional |
date |
|
| popupEndDate |
Optional |
date |
|
| SESSIONUSERKEY |
Required |
numeric |
|
| popupisActiveBit |
Required |
boolean |
|
| popupOrder |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEPOPUP |
| function deletePopup |
Arguments:
| Name |
Required |
Type |
Default |
| popupKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCONTENTBOXCONFIGXML |
| function getContentBoxConfigXML |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPOPUP |
| function getPopup |
Arguments:
| Name |
Required |
Type |
Default |
| popupKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPOPUPCONTENT |
| function getPopupContent |
Arguments:
| Name |
Required |
Type |
Default |
| popupKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETSITEMAPXML |
| function getSiteMapXML |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTALLPRODUCTSDROPDOWN |
| function insertAllProductsDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| style |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a Yes/No Dropdown field into the HTML page |
| Description: |
|
|
|
| INSERTAPPLICATIONSTATUSDROPDOWN |
| function insertApplicationStatusDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| style |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTAPPLICATIONSTATUSDROPDOWNNOTREQUIRED |
| function insertApplicationStatusDropdownNotRequired |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| style |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCATEGORYDROPDOWN |
| function insertCategoryDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| isMultiple |
Optional |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCATEGORYDROPDOWNBYCLIENTKEYWITHONCHANGE |
| function insertCategoryDropdownByClientKeyWithOnChange |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| clientKey |
Required |
numeric |
|
| defaultValue |
Required |
numeric |
|
| class |
Optional |
string |
|
| style |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCATEGORYPAGESTYLEDROPDOWN |
| function insertCategoryPageStyleDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| categoryPageStyleKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCATEGORYTYPEDROPDOWN |
| function insertCategoryTypeDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| isMultiple |
Optional |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCERTIFICATIONDROPDOWN |
| function insertCertificationDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| validate |
Optional |
boolean |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCLASSTYPEDROPDOWN |
| function insertClassTypeDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| style |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCLIENTAPPEARANCECONTENTDROPDOWN |
| function insertClientAppearanceContentDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| clientKey |
Required |
numeric |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCLIENTDROPDOWN |
| function insertClientDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
numeric |
|
| showAllClientsOption |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a client name deopdown |
| Description: |
|
|
|
| INSERTCLIENTDROPDOWNONCHANGE |
| function insertClientDropdownOnChange |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| defaultKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCOMPANYSIZEDROPDOWN |
| function insertCompanySizeDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| validate |
Optional |
boolean |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCOUNTRYDROPDOWN |
| function insertCountryDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCREDITCARDDROPDOWN |
| function insertCreditCardDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| style |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCUSTOMERTYPEDROPDOWN |
| function insertCustomerTypeDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| clientKey |
Optional |
numeric |
|
| class |
Optional |
string |
|
| required |
Optional |
boolean |
|
| showAllOption |
Optional |
boolean |
|
| multiSelectSize |
Optional |
numeric |
|
| defaultValueLIST |
Optional |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCUSTOMEVENTDROPDOWN |
| function insertCustomEventDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| questionKey |
Required |
numeric |
|
| defaultValue |
Optional |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTEMAILCONTENTDROPDOWN |
| function insertEmailContentDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| clientKey |
Required |
numeric |
|
| style |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a Yes/No Dropdown field into the HTML page |
| Description: |
|
|
|
| INSERTEMAILCONTENTTYPESDROPDOWN |
| function insertEmailContentTypesDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| clientKey |
Required |
numeric |
|
| style |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a Yes/No Dropdown field into the HTML page |
| Description: |
|
|
|
| INSERTEXEMPTORNOTDROPDOWN |
| function insertExemptOrNotDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTFILTERBYCUSTOMERTYPEDROPDOWN |
| function insertFilterByCustomerTypeDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| clientKey |
Required |
numeric |
|
| defaultValue |
Optional |
numeric |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTINDUSTRYDROPDOWN |
| function insertIndustryDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| validate |
Optional |
boolean |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTMEMBERSHIPDROPDOWN |
| function insertMembershipDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTMONTHDROPDOWN |
| function insertMonthDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| required |
Optional |
numeric |
|
| style |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTNEWMEMBERSHIPDROPDOWN |
| function insertNewMembershipDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTPAYMENTTYPEDROPDOWN |
| function insertPaymentTypeDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTPAYMENTTYPEDROPDOWNNOTREQUIRED |
| function insertPaymentTypeDropdownNotRequired |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTPOPUPLOCATIONDROPDOWN |
| function insertPopupLocationDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTPRODUCTBYTYPEDROPDOWN |
| function insertProductByTypeDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| clientKey |
Required |
numeric |
|
| productTypeKey |
Optional |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTPRODUCTCATEGORYDROPDOWN |
| function insertProductCategoryDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| isMultiple |
Required |
numeric |
|
| class |
Optional |
string |
|
| style |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTPRODUCTFORPROMODROPDOWN |
| function insertProductForPromoDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| clientKey |
Required |
numeric |
|
| class |
Optional |
string |
|
| style |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTPRODUCTMULTIPRICEANDSIZEDROPDOWN |
| function insertProductMultiPriceAndSizeDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| productKey |
Optional |
numeric |
|
| class |
Optional |
string |
|
| style |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTPRODUCTMULTIPRICEDROPDOWN |
| function insertProductMultiPriceDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| productKey |
Optional |
numeric |
|
| class |
Optional |
string |
|
| style |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTPRODUCTSDROPDOWN |
| function insertProductsDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| clientKey |
Required |
numeric |
|
| selectedProductKey |
Optional |
numeric |
|
| class |
Optional |
string |
|
| style |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTPRODUCTSIZEDROPDOWN |
| function insertProductSizeDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| style |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTPRODUCTTYPEDROPDOWNWITHBASICONCHANGE |
| function insertProductTypeDropDownWithBasicOnChange |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| defaultValue |
Required |
numeric |
|
| class |
Optional |
string |
|
| style |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTPRODUCTTYPEDROPDOWNWITHONCHANGE |
| function insertProductTypeDropdownWithOnChange |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| changeFieldName |
Required |
string |
|
| changeFieldValue |
Required |
numeric |
|
| class |
Optional |
string |
|
| style |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTPROMOCODETYPEDROPDOWN |
| function insertPromoCodeTypeDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| style |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTQUANTITYDROPDOWN |
| function insertQuantityDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| style |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a Yes/No Dropdown field into the HTML page |
| Description: |
|
|
|
| INSERTREPORTTYPEDROPDOWN |
| function insertReportTypeDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| isUserSuperAdmin |
Required |
boolean |
|
| class |
Optional |
string |
|
| style |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTSTATENAMEDROPDOWN |
| function insertStateNameDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| style |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a Dropdown with full state names into the HTML page |
| Description: |
|
|
|
| INSERTTIMEZONEDROPDOWN |
| function insertTimeZoneDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
| required |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a dropdown showing the time zone options |
| Description: |
|
|
|
| INSERTXYREPEATDROPDOWN |
| function insertXYRepeatDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| style |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a Yes/No Dropdown field into the HTML page |
| Description: |
|
|
|
| INSERTYEARDROPDOWN |
| function insertYearDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| required |
Optional |
numeric |
|
| style |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTYESNODROPDOWN |
| function insertYesNoDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a Yes/No Dropdown field into the HTML page |
| Description: |
|
|
|
| INSERTYESNOWITHONCHANGEDROPDOWN |
| function insertYesNoWithOnChangeDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| runThisFunction |
Optional |
string |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a Yes/No Dropdown field into the HTML page |
| Description: |
|
|
|
| POPUPWASDISPLAYED |
| function popupWasDisplayed |
Arguments:
| Name |
Required |
Type |
Default |
| popupKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEPOPUP |
| function updatePopup |
Arguments:
| Name |
Required |
Type |
Default |
| popupKey |
Required |
numeric |
|
| popupName |
Optional |
string |
|
| popupContent |
Optional |
string |
|
| popupLocationFK |
Required |
numeric |
|
| popupStartDate |
Optional |
date |
|
| popupEndDate |
Optional |
date |
|
| SESSIONUSERKEY |
Required |
numeric |
|
| popupisActiveBit |
Required |
boolean |
|
| popupOrder |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| companylogofile |
2-10-1-BFAE52F6-155D-82F2-B80CB8E2F8B928BD.png
|
| componentloggingisonbit |
1
|
| componentlogison |
1
|
| conferenceservice |
| [cfc25] component
components.conference.ConferenceService
|
| METHODS |
| CLEARCONFERENCESPEAKERHASH |
| function clearConferenceSpeakerHash |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| groupKey |
Required |
numeric |
|
| eventKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETECONFERENCESESSION |
| function deleteConferenceSession |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| eventKey |
Required |
numeric |
|
| conferenceSessionKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCLIENTPRODUCTBYKEY |
| function getClientProductByKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| productKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCLIENTPRODUCTSBYTYPE |
| function getClientProductsByType |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| productTypeKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCLIENTPRODUCTSBYTYPEINJSON |
| function getClientProductsByTypeInJSON |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| productTypeKey |
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: |
|
|
|
| GETCONFERENCESESSIONBYKEYWITHSPEAKERS |
| function getConferenceSessionByKeyWithSpeakers |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| eventKey |
Required |
numeric |
|
| sessionKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCONFERENCESESSIONS |
| function getConferenceSessions |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| eventKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCONFERENCESESSIONSBYSPEAKER |
| function getConferenceSessionsBySpeaker |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| eventKey |
Required |
numeric |
|
| speakerKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCONFERENCESESSIONSINJSON |
| function getConferenceSessionsInJSON |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| eventKey |
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: |
|
|
|
| GETCONFERENCESESSIONSWITHSPEAKERS |
| function getConferenceSessionsWithSpeakers |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| eventKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCONFERENCESPEAKERBYKEY |
| function getConferenceSpeakerByKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| eventKey |
Required |
numeric |
|
| speakerKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCONFERENCESPEAKERSBYEVENTKEY |
| function getConferenceSpeakersByEventKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| eventKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCONFERENCESPEAKERSINJSON |
| function getConferenceSpeakersInJSON |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| eventKey |
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: |
|
|
|
| INSERTCONFERENCESPEAKERASSIGNMENTDROPDOWN |
| function insertConferenceSpeakerAssignmentDropDown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| clientKey |
Required |
numeric |
|
| membersOnly |
Required |
boolean |
|
| activeOnly |
Required |
boolean |
|
| eventKey |
Required |
numeric |
|
| class |
Optional |
string |
|
| hideShowAll |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTSESSIONLOCATIONDROPDOWN |
| function insertSessionLocationDropDown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| clientKey |
Required |
numeric |
|
| eventKey |
Required |
numeric |
|
| conferenceSessionKey |
Required |
numeric |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTSESSIONSPEAKERASSIGNMENTDROPDOWN |
| function insertSessionSpeakerAssignmentDropDown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| clientKey |
Required |
numeric |
|
| eventKey |
Required |
numeric |
|
| conferenceSessionKey |
Required |
numeric |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| MAINTAINCONFERENCESESSIONSPEAKERHASH |
| function maintainConferenceSessionSpeakerHash |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| eventKey |
Required |
numeric |
|
| conferenceSessionKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| conferenceSessionSpeakerKeyLIST |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| MAINTAINCONFERENCESPEAKERHASH |
| function maintainConferenceSpeakerHash |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| groupKey |
Required |
numeric |
|
| eventKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| conferenceSpeakerCustomerKeyLIST |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATESPEAKERKEYNOTEDEFAULT |
| function updateSpeakerKeynoteDefault |
Arguments:
| Name |
Required |
Type |
Default |
| action |
Required |
boolean |
|
| speakerKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATESPEAKERKEYNOTESORTORDER |
| function updateSpeakerKeynoteSortOrder |
Arguments:
| Name |
Required |
Type |
Default |
| newPosition |
Required |
numeric |
|
| speakerKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| eventKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| conferencesessionsdao |
| [cfc26] component
components.conference.conferenceSessions.ConferenceSessionsDAO
|
| METHODS |
| CREATECONFERENCESESSIONS |
| function createConferenceSessions |
Arguments:
| Name |
Required |
Type |
Default |
| ConferenceSessionsOBJ |
Required |
ConferenceSessions |
|
|
| ReturnType: |
ConferenceSessions
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETECONFERENCESESSIONS |
| function deleteConferenceSessions |
Arguments:
| Name |
Required |
Type |
Default |
| ConferenceSessionsOBJ |
Required |
ConferenceSessions |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCONFERENCESESSIONS |
| function getConferenceSessions |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
ConferenceSessions
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATECONFERENCESESSIONS |
| function updateConferenceSessions |
Arguments:
| Name |
Required |
Type |
Default |
| ConferenceSessionsOBJ |
Required |
ConferenceSessions |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| contactrequestallowance |
2
|
| contentblocksdao |
| [cfc27] component
components.contentBlocks.contentBlocksDAO
|
| METHODS |
| CREATECONTENTBLOCKS |
| function createContentBlocks |
Arguments:
| Name |
Required |
Type |
Default |
| ContentBlocksOBJ |
Required |
ContentBlocks |
|
|
| ReturnType: |
ContentBlocks
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETECONTENTBLOCKS |
| function deleteContentBlocks |
Arguments:
| Name |
Required |
Type |
Default |
| ContentBlocksOBJ |
Required |
ContentBlocks |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCONTENTBLOCKS |
| function getContentBlocks |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
ContentBlocks
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATECONTENTBLOCKS |
| function updateContentBlocks |
Arguments:
| Name |
Required |
Type |
Default |
| ContentBlocksOBJ |
Required |
ContentBlocks |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| contentblocksservice |
| [cfc28] component
components.contentBlocks.contentBlocksService
|
| METHODS |
| CREATECONTENTBLOCK |
| function createContentBlock |
Arguments:
| Name |
Required |
Type |
Default |
| thumbnail |
Required |
string |
|
| categoryKey |
Required |
numeric |
|
| htmlString |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETALLCONTENTBLOCKSFORDISPLAY |
| function getAllContentBlocksForDisplay |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCONTENTBLOCKBYKEY |
| function getContentBlockByKey |
Arguments:
| Name |
Required |
Type |
Default |
| contentBlockKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCONTENTBLOCKCATEGORIES |
| function getContentBlockCategories |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Gets all content block categories |
| Description: |
|
|
|
| GETCONTENTBLOCKCATEGORIESSTRING |
| function getContentBlockCategoriesSTRING |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| applicationKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCONTENTBLOCKCATEGORYSNIPPETINJSON |
| function getContentBlockCategorySnippetInJSON |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| applicationKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCONTENTBLOCKSBYCLIENTINJSON |
| function getContentBlocksByClientInJSON |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| activeOnly |
Required |
boolean |
|
| categoryAutoKey |
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: |
|
|
|
| GETCONTENTBLOCKSFOREDITOR |
| function getContentBlocksForEditor |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCONTENTBLOCKSFORMATTEDFOREDITOR |
| function getContentBlocksFormattedForEditor |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCONTENTBLOCKSFORMATTEDFOREDITORINJSON |
| function getContentBlocksFormattedForEditorInJSON |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCONTENTBLOCKSFORMATTEDFOREDITORINJSONV2 |
| function getContentBlocksFormattedForEditorInJSONV2 |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCONTENTBLOCKSFORMATTEDJSONFOREDITOR |
| function getContentBlocksFormattedJSONForEditor |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCONTENTBLOCKSFORMATTEDJSONFOREDITORV2 |
| function getContentBlocksFormattedJSONForEditorV2 |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCONTENTBLOCKAPPLICATIONDROPDOWN |
| function insertContentBlockApplicationDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a Yes/No Dropdown field into the HTML page |
| Description: |
|
|
|
| INSERTCONTENTBLOCKCATEGORYDROPDOWN |
| function insertContentBlockCategoryDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Required |
string |
|
| defaultValue |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a slushbox html |
| Description: |
|
|
|
| INSERTCONTENTBLOCKCATEGORYMULTISELECT |
| function insertContentBlockCategoryMultiSelect |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| contentBlockKey |
Required |
numeric |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a slushbox html |
| Description: |
|
|
|
| INSERTCONTENTBLOCKCLIENTDROPDOWN |
| function insertContentBlockClientDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a Yes/No Dropdown field into the HTML page |
| Description: |
|
|
|
| RUNIMAGEUPLOADROUTINE |
| function runImageUploadRoutine |
Arguments:
| Name |
Required |
Type |
Default |
| imageNumber |
Required |
numeric |
|
| fileExt |
Required |
string |
|
| imageName |
Required |
string |
|
| imageBase364String |
Required |
string |
|
| imageCustomValue |
Required |
numeric |
|
| SessionUserKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATECONTENTBLOCKCATEGORYHASH |
| function updateContentBlockCategoryHash |
Arguments:
| Name |
Required |
Type |
Default |
| userKey |
Required |
numeric |
|
| contentBlockKey |
Required |
numeric |
|
| contentBlockCategoryList |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| contentboxassetdiskpath |
E:\WEB\mightecontent.com.v3\files\contentbuilder\2\assets\
|
| contentboxasseturlpath |
/files/contentbuilder/2/assets/
|
| contentboxuploadpath |
E:\WEB\mightecontent.com.v3\files\contentbuilder\2\
|
| contentboxurlpath |
/files/contentbuilder/2/
|
| contentbuilderblockscoverimagediskpath |
E:\WEB\mightecontent.com.v3\shared-assets\plugins\content-builder\content-builder-blocks\img-cover\2\
|
| contentbuilderblockscoverimageurlpath |
https://beta.mightecontent.com/shared-assets/plugins/content-builder/content-builder-blocks/img-cover/2/
|
| contentbuilderblockscoverthumbnaildiskpath |
E:\WEB\mightecontent.com.v3\shared-assets\plugins\content-builder\content-builder-blocks\thumbnails-cover\2\
|
| contentbuilderblockscoverthumbnailurlpath |
https://beta.mightecontent.com/shared-assets/plugins/content-builder/content-builder-blocks/thumbnails-cover/2/
|
| contentbuilderblocksimagediskpath |
E:\WEB\mightecontent.com.v3\shared-assets\plugins\content-builder\content-builder-blocks\img\
|
| contentbuilderblocksimageurlpath |
/shared-assets/plugins/content-builder/content-builder-blocks/img/
|
| contentbuilderblockssnazzoimageurlpath |
/shared-assets/plugins/content-builder/content-builder-blocks/img/snazzo/
|
| contentbuilderblocksthumbnaildiskpath |
E:\WEB\mightecontent.com.v3\shared-assets\plugins\content-builder\content-builder-blocks\thumbnails\
|
| contentbuilderblocksthumbnailurlpath |
/shared-assets/plugins/content-builder/content-builder-blocks/thumbnails/
|
| contentbuildercoverimagerequiredheight |
1600
|
| contentbuildercoverimagerequiredwidth |
1600
|
| contentbuilderimagediskpath |
E:\WEB\mightecontent.com.v3\assets\custom\img\appearance\
|
| contentbuilderimagerelativeurlpath |
/assets/custom/img/appearance/
|
| contentbuilderimagethumbnaildiskpath |
E:\WEB\mightecontent.com.v3\assets\custom\img\appearanceThumbs\
|
| contentbuilderimagethumbnailrelativeurlpath |
/assets/custom/img/appearanceThumbs/
|
| contentbuilderimagethumbnailurlpath |
https://beta.mightecontent.com/assets/custom/img/appearanceThumbs/
|
| contentbuilderimageurlpath |
https://beta.mightecontent.com/assets/custom/img/appearance/
|
| cookiedomainname |
mightecontent.com
|
| cookieuniquestring |
MECM
|
| customcodeblockdiskpath |
E:\WEB\mightecontent.com.v3\assets\custom\content-files\custom-content\
|
| customcodeblockurlpath |
/assets/custom/content-files/custom-content/
|
| customeraddressesdao |
| [cfc29] component
components.customers.customerAddressesDAO
|
| METHODS |
| DELETECUSTOMERADDRESSES |
| function deleteCustomerAddresses |
Arguments:
| Name |
Required |
Type |
Default |
| CustomerAddressesOBJ |
Required |
CustomerAddresses |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERADDRESSES |
| function getCustomerAddresses |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
CustomerAddresses
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATECUSTOMERADDRESSES |
| function updateCustomerAddresses |
Arguments:
| Name |
Required |
Type |
Default |
| CustomerAddressesOBJ |
Required |
CustomerAddresses |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| customeraddressesgateway |
| [cfc30] component
components.customers.customerAddressesGateway
|
| METHODS |
| DELETEADDRESSESBYCUSTOMERKEY |
| function deleteAddressesByCustomerKey |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETALLCUSTOMERADDRESSES |
| function getAllCustomerAddresses |
| Arguments: | none |
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERADDRESSESBYADDRESSKEYANDTYPE |
| function getCustomerAddressesByAddressKeyAndType |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
CustomerAddresses
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERADDRESSESBYKEYANDTYPE |
| function getCustomerAddressesByKeyAndType |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
| addressType |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATENEWCUSTOMERADDRESSES |
| function updateNewCustomerAddresses |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| customerbusinesslocationsdao |
| [cfc31] component
components.customers.customerBusinessLocationsDAO
|
| METHODS |
| CREATECUSTOMERBUSINESSLOCATIONS |
| function createCustomerBusinessLocations |
Arguments:
| Name |
Required |
Type |
Default |
| CustomerBusinessLocationsOBJ |
Required |
CustomerBusinessLocations |
|
|
| ReturnType: |
CustomerBusinessLocations
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETECUSTOMERBUSINESSLOCATIONS |
| function deleteCustomerBusinessLocations |
Arguments:
| Name |
Required |
Type |
Default |
| CustomerBusinessLocationsOBJ |
Required |
CustomerBusinessLocations |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERBUSINESSLOCATIONS |
| function getCustomerBusinessLocations |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
CustomerBusinessLocations
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATECUSTOMERBUSINESSLOCATIONS |
| function updateCustomerBusinessLocations |
Arguments:
| Name |
Required |
Type |
Default |
| CustomerBusinessLocationsOBJ |
Required |
CustomerBusinessLocations |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| customerclientkey |
2
|
| customersdao |
| [cfc32] component
components.customers.customersDAO
|
| METHODS |
| CREATECUSTOMERS |
| function createCustomers |
Arguments:
| Name |
Required |
Type |
Default |
| CustomersOBJ |
Required |
Customers |
|
|
| ReturnType: |
Customers
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETECUSTOMERS |
| function deletecustomers |
Arguments:
| Name |
Required |
Type |
Default |
| customersOBJ |
Required |
customers |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERS |
| function getCustomers |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
customers
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATECUSTOMERS |
| function updatecustomers |
Arguments:
| Name |
Required |
Type |
Default |
| customersOBJ |
Required |
customers |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| customersgateway |
| [cfc33] component
components.customers.customersGateway
|
| METHODS |
| DUPLICATELOGINCHECK |
| function duplicateLoginCheck |
Arguments:
| Name |
Required |
Type |
Default |
| username |
Required |
string |
|
| password |
Required |
string |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMEREMAILLISTASLIST |
| function getCustomerEmailListAsList |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMEREMAILLISTASLISTFROMQUERY |
| function getCustomerEmailListAsListFromQuery |
Arguments:
| Name |
Required |
Type |
Default |
| OrderBy |
Required |
string |
|
| OrderByType |
Required |
string |
|
| letterChosen |
Required |
string |
|
| searchTerm |
Required |
string |
|
| filterType |
Required |
string |
|
| membersOnly |
Optional |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERFULLNAME |
| function getCustomerFullName |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERMEMBERSHIPTYPES |
| function getCustomerMembershipTypes |
Arguments:
| Name |
Required |
Type |
Default |
| activeOnly |
Optional |
boolean |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERS |
| function getCustomers |
Arguments:
| Name |
Required |
Type |
Default |
| customerTypeKey |
Required |
numeric |
|
| OrderBy |
Required |
string |
|
| OrderByType |
Required |
string |
|
| letterChosen |
Required |
string |
|
| searchTerm |
Required |
string |
|
| filterType |
Required |
string |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERSBYCLIENT |
| function getCustomersByClient |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERSCOUNT |
| function getCustomersCount |
| Arguments: | none |
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERSFORMAPBYCLIENT |
| function getCustomersForMapByClient |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERSFORXML |
| function getCustomersForXML |
Arguments:
| Name |
Required |
Type |
Default |
| customerTypeKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERSMEMBERSHIPSTATUS |
| function getCustomersMembershipStatus |
Arguments:
| Name |
Required |
Type |
Default |
| userKey |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETEMAILLISTCOUNT |
| function getEmailListCount |
Arguments:
| Name |
Required |
Type |
Default |
| listKey |
Required |
numeric |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETINACTIVECUSTOMERSBYCLIENT |
| function getInactiveCustomersByClient |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETLIVEBROADCASTEMAILLIST |
| function getLiveBroadcastEmailList |
Arguments:
| Name |
Required |
Type |
Default |
| listKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETRANDOMPASSWORD |
| function getRandomPassword |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETRERUNLIVEBROADCASTEMAILLIST |
| function getReRunLiveBroadcastEmailList |
Arguments:
| Name |
Required |
Type |
Default |
| listKey |
Required |
numeric |
|
| newsletterKey |
Required |
numeric |
|
| newsletterQueueKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETSITEMEMBERSBYCLIENT |
| function getSiteMembersByClient |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETTESTBROADCASTEMAILLIST |
| function getTestBroadcastEmailList |
Arguments:
| Name |
Required |
Type |
Default |
| testKeyList |
Required |
string |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTTESTBROADCASTLIST |
| function insertTestBroadcastList |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| style |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UNSUBSCRIBETHISUSER |
| function unsubscribeThisUser |
Arguments:
| Name |
Required |
Type |
Default |
| userKey |
Required |
numeric |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATECUSTOMERACTIVITYLOG |
| function updateCustomerActivityLog |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Update user activity log. |
| Description: |
|
|
|
| UPDATECUSTOMERLASTLOGIN |
| function updateCustomerLastLogin |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Update user activity log. |
| Description: |
|
|
|
| VALIDATECREDENTIALS |
| function validateCredentials |
Arguments:
| Name |
Required |
Type |
Default |
| username |
Required |
string |
|
| password |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Validate a users login credentials |
| Description: |
|
|
|
|
|
| customersinapplicationkey |
2
|
| customersremoteservice |
| [cfc34] component
components.remoteService.customersRemoteService
|
| METHODS |
| GETCUSTOMERSEMAILLISTSBYCLIENTANDLISTTYPE |
| function getCustomersEmailListsByClientAndListType |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| emailListKey |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERSEMAILLISTSBYCLIENTANDLISTTYPECOUNT |
| function getCustomersEmailListsByClientAndListTypeCount |
Arguments:
| Name |
Required |
Type |
Default |
| emailListKey |
Required |
numeric |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETEMAILLISTBYLISTTYPEKEY |
| function getEmailListByListTypeKey |
Arguments:
| Name |
Required |
Type |
Default |
| listTypeKey |
Required |
numeric |
|
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETEMAILLISTSBYCLIENTKEY |
| function getEmailListsByClientKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UNSUBSCRIBERUSER |
| function unsubscriberUser |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| customerKey |
Required |
numeric |
|
| emailAddress |
Required |
string |
|
| emailListKey |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| customersservice |
| [cfc35] component
components.customers.customersService
|
| METHODS |
| CHECKEMAILADDRESSTOSEEIFITEXISTS |
| function checkEmailAddressToSeeIfItExists |
Arguments:
| Name |
Required |
Type |
Default |
| emailAddress |
Required |
string |
|
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATEPROFILEIMAGE |
| function createProfileImage |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
| largeFileName |
Required |
string |
|
| thumbnailFileName |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETECUSTOMER |
| function deleteCustomer |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETECUSTOMERBUSINESSLOCATION |
| function deleteCustomerBusinessLocation |
Arguments:
| Name |
Required |
Type |
Default |
| businessLocationKey |
Required |
numeric |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| FORGOTPASSWORD |
| function forgotPassword |
Arguments:
| Name |
Required |
Type |
Default |
| username |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERACCESSNOTIFICATIONTEXT |
| function getCustomerAccessNotificationText |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERBIO |
| function getCustomerBio |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERBIOANDPHOTO |
| function getCustomerBioAndPhoto |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERBUSINESSLOCATION |
| function getCustomerBusinessLocation |
Arguments:
| Name |
Required |
Type |
Default |
| businessLocationKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERBUSINESSLOCATIONDETAILSINHTML |
| function getCustomerBusinessLocationDetailsInHTML |
Arguments:
| Name |
Required |
Type |
Default |
| businessLocationKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERBUSINESSLOCATIONDETAILSWITHCATEGORIESINHTML |
| function getCustomerBusinessLocationDetailsWithCategoriesInHTML |
Arguments:
| Name |
Required |
Type |
Default |
| businessLocationKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERBUSINESSLOCATIONS |
| function getCustomerBusinessLocations |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERDETAILS |
| function getCustomerDetails |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERDETAILSFORAUTOLOGIN |
| function getCustomerDetailsForAutoLogin |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERSBYCLIENT |
| function getCustomersByClient |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERSBYCLIENTANDCUSTOMERTYPEINJSON |
| function getCustomersByClientAndCustomerTypeInJSON |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| customerTypeKey |
Required |
numeric |
|
| start |
Required |
numeric |
|
| length |
Required |
numeric |
|
| draw |
Required |
numeric |
|
| searchTerm |
Required |
string |
|
| orderColumn |
Required |
numeric |
|
| orderDirection |
Required |
string |
|
| SSLPaymentURL |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERSBYCLIENTINJSON |
| function getCustomersByClientInJSON |
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 |
|
| SSLPaymentURL |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERSFORTROUBLESHOOTINGINJSON |
| function getCustomersForTroubleshootingInJSON |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
| clientKey |
Required |
numeric |
|
| orderKey |
Required |
numeric |
|
| lastName |
Required |
string |
|
| emailAddress |
Required |
string |
|
| 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: |
|
|
|
| GETCUSTOMERTYPESTRING |
| function getCustomerTypeSTRING |
Arguments:
| Name |
Required |
Type |
Default |
| customerTypeKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERTYPESTRINGBYKEY |
| function getCustomerTypeStringByKey |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDEFAULTPASSWORD |
| function getDefaultPassword |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCLIENTDROPDOWNBYCUSTOMERKEY |
| function insertClientDropdownByCustomerKey |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| LOGINVALIDATION |
| function loginValidation |
Arguments:
| Name |
Required |
Type |
Default |
| username |
Required |
string |
|
| password |
Required |
string |
|
| userSessionTracker |
Optional |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Validate a users login credentials |
| Description: |
|
|
|
| SENDNEWCUSTOMERSIGNUPDETAILS |
| function sendNewCustomerSignUpDetails |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
| userSessionTracker |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATECUSTOMERACTIVITYLOG |
| function updateCustomerActivityLog |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
| activityDescription |
Required |
string |
|
| activityAdditionalInformation |
Required |
string |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Update user activity log. |
| Description: |
|
|
|
| UPDATECUSTOMERCLIENTHASHWITHLIST |
| function updateCustomerClientHashWithList |
Arguments:
| Name |
Required |
Type |
Default |
| assigningToCustomerKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| clientKeyLIST |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATECUSTOMERLASTLOGIN |
| function updateCustomerLastLogin |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Update user activity log. |
| Description: |
|
|
|
|
|
| datasource |
MightEContentDemoDatasource
|
| dateinitialized |
{ts '2025-12-10 11:59:44'}
|
| defaultimagediskpath |
E:\WEB\mightecontent.com.v3\assets\custom\img\
|
| defaultimageurlpath |
/assets/custom/img/
|
| defaultthumbnaildiskpath |
E:\WEB\mightecontent.com.v3\assets\custom\img\
|
| defaultthumbnailurlpath |
/assets/custom/img/
|
| documentationarticlesdao |
| [cfc36] component
components.MightEDocs.articles.MIGHTEDOCS_ArticlesDAO
|
| METHODS |
| CREATENEWDOCUMENTARTICLE |
| function createNewDocumentArticle |
Arguments:
| Name |
Required |
Type |
Default |
| MIGHTEDOCS_ArticlesOBJ |
Required |
MIGHTEDOCS_Articles |
|
| clientKey |
Required |
numeric |
|
| documentKey |
Required |
numeric |
|
|
| ReturnType: |
MIGHTEDOCS_Articles
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEARTICLE |
| function deleteArticle |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| documentKey |
Required |
numeric |
|
| chapterKey |
Required |
numeric |
|
| articleKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETARTICLE |
| function getArticle |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
MIGHTEDOCS_Articles
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEARTICLE |
| function updateArticle |
Arguments:
| Name |
Required |
Type |
Default |
| MIGHTEDOCS_ArticlesOBJ |
Required |
MIGHTEDOCS_Articles |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| documentationarticlesservice |
| [cfc37] component
components.MightEDocs.articles.MIGHTEDOCS_ArticlesService
|
| METHODS |
| GETARTICLESFORADMINPAGINATED |
| function getArticlesForAdminPaginated |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| customerKey |
Required |
numeric |
|
| documentationKey |
Required |
numeric |
|
| documentChapterKey |
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: |
|
|
|
| GETDOCUMENTSECTIONSBYKEY |
| function getDocumentSectionsByKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| documentationKey |
Required |
numeric |
|
| documentChapterKey |
Required |
numeric |
|
| documentSectionKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTSECTIONCHAPTERSDROPDOWN |
| function insertSectionChaptersDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| clientKey |
Required |
numeric |
|
| documentKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEARTICLEACTIVESTATUS |
| function updateArticleActiveStatus |
Arguments:
| Name |
Required |
Type |
Default |
| action |
Required |
boolean |
|
| articleKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| documentationKey |
Required |
numeric |
|
| documentChapterKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEARTICLESORTORDER |
| function updateArticleSortOrder |
Arguments:
| Name |
Required |
Type |
Default |
| newPosition |
Required |
numeric |
|
| articleKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| documentationKey |
Required |
numeric |
|
| documentChapterKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| documentationchaptersdao |
| [cfc38] component
components.MightEDocs.pages.MIGHTEDOCS_ChaptersDAO
|
| METHODS |
| CREATENEWDOCUMENTCHAPTER |
| function createNewDocumentChapter |
Arguments:
| Name |
Required |
Type |
Default |
| MIGHTEDOCS_ChaptersOBJ |
Required |
MIGHTEDOCS_Chapters |
|
|
| ReturnType: |
MIGHTEDOCS_Chapters
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEDOCUMENTCHAPTER |
| function deleteDocumentChapter |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| documentKey |
Required |
numeric |
|
| chapterKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDOCUMENTCHAPTERS |
| function getDocumentChapters |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
MIGHTEDOCS_Chapters
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEDOCUMENTCHAPTERS |
| function updateDocumentChapters |
Arguments:
| Name |
Required |
Type |
Default |
| MIGHTEDOCS_ChaptersOBJ |
Required |
MIGHTEDOCS_Chapters |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| documentationchaptersservice |
| [cfc39] component
components.MightEDocs.pages.MIGHTEDOCS_ChaptersService
|
| METHODS |
| GETDOCUMENTCHAPTERSBYKEY |
| function getDocumentChaptersByKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| customerKey |
Required |
numeric |
|
| documentationKey |
Required |
numeric |
|
| documentationPageKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDOCUMENTCHAPTERSECTIONSBYCHAPTERKEY |
| function getDocumentChapterSectionsByChapterKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| documentationKey |
Required |
numeric |
|
| documentChapterKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDOCUMENTCHAPTERSFORADMINPAGINATED |
| function getDocumentChaptersForAdminPaginated |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| customerKey |
Required |
numeric |
|
| documentationKey |
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: |
|
|
|
| UPDATEPAGEACTIVESTATUS |
| function updatePageActiveStatus |
Arguments:
| Name |
Required |
Type |
Default |
| action |
Required |
boolean |
|
| pageKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| documentationKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEPAGESORTORDER |
| function updatePageSortOrder |
Arguments:
| Name |
Required |
Type |
Default |
| newPosition |
Required |
numeric |
|
| pageKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| documentationKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| documentationdao |
| [cfc40] component
components.MightEDocs.documentation.MIGHTEDOCS_DocumentationDAO
|
| METHODS |
| CREATEDOCUMENTATION |
| function createDocumentation |
Arguments:
| Name |
Required |
Type |
Default |
| DocumentationOBJ |
Required |
Documentation |
|
|
| ReturnType: |
MIGHTEDOCS_Documentation
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEDOCUMENTATION |
| function deleteDocumentation |
Arguments:
| Name |
Required |
Type |
Default |
| documentationKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDOCUMENTATION |
| function getDocumentation |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
MIGHTEDOCS_Documentation
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEDOCUMENTATION |
| function updateDocumentation |
Arguments:
| Name |
Required |
Type |
Default |
| DocumentationOBJ |
Required |
MIGHTEDOCS_Documentation |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| documentationservice |
| [cfc41] component
components.MightEDocs.documentation.MIGHTEDOCS_DocumentationService
|
| METHODS |
| GETDOCUMENT |
| function getDocument |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| documentationKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDOCUMENTATIONNAVIGATIONFORPUBLICVIEW |
| function getDocumentationNavigationForPublicView |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| customerKey |
Required |
numeric |
|
| documentationKey |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDOCUMENTBYKEY |
| function getDocumentByKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| customerKey |
Required |
numeric |
|
| documentationKey |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDOCUMENTBYKEYFORADMIN |
| function getDocumentByKeyForAdmin |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| customerKey |
Required |
numeric |
|
| documentationKey |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDOCUMENTCHAPTERCONTENTBYDOCUMENTCHAPTERKEY |
| function getDocumentChapterContentByDocumentChapterKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| documentationKey |
Required |
numeric |
|
| chapterKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDOCUMENTCHAPTERSBYDOCUMENTKEY |
| function getDocumentChaptersByDocumentKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| documentationKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDOCUMENTCHAPTERSPAGINATEDBYDOCUMENTKEY |
| function getDocumentChaptersPaginatedByDocumentKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| documentationKey |
Required |
numeric |
|
| chapterKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDOCUMENTPUBLICNAVIGATION |
| function getDocumentPublicNavigation |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| documentationKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDOCUMENTSFORADMIN |
| function getDocumentsForAdmin |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDOCUMENTSFORADMINPAGINATED |
| function getDocumentsForAdminPaginated |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| customerKey |
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: |
|
|
|
| GETDOCUMENTSFORPUBLIC |
| function getDocumentsForPublic |
Arguments:
| Name |
Required |
Type |
Default |
| sessionUserKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTAPPROVALSTATUSDROPDOWN |
| function insertApprovalStatusDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTDOCUMENTAUTHORDROPDOWN |
| function insertDocumentAuthorDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| sessionUserKey |
Required |
numeric |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTDOCUMENTSDROPDOWNFORADMIN |
| function insertDocumentsDropdownForAdmin |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| sessionUserKey |
Required |
numeric |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SAVEDATATEST |
| function saveDataTest |
Arguments:
| Name |
Required |
Type |
Default |
| order |
Required |
any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| emailattachmentsfolder |
E:\WEB\shared-assets\2\
|
| emailmanagerservice |
| [cfc42] component
components.emailManager.emailManagerService
|
| METHODS |
| COPYEMAILFROMSERVERTODATABASE |
| function copyEmailFromServerToDatabase |
Arguments:
| Name |
Required |
Type |
Default |
| numberOfRows |
Required |
numeric |
|
| userKey |
Required |
numeric |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| COPYEMAILFROMSERVERTODATABASEANDDELETE |
| function copyEmailFromServerToDatabaseAndDelete |
Arguments:
| Name |
Required |
Type |
Default |
| numberOfRows |
Required |
numeric |
|
| userKey |
Required |
numeric |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETIMPORTEDEMAILS |
| function getImportedEmails |
| Arguments: | none |
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| emailnoticeauditdao |
| [cfc43] component
components.emailDistribution.emailNoticeAuditDAO
|
| METHODS |
| INSERTEMAILNOTICEAUDIT |
| function insertEmailNoticeAudit |
Arguments:
| Name |
Required |
Type |
Default |
| description |
Required |
string |
|
| noticeTypeKey |
Required |
numeric |
|
| incidentKey |
Required |
numeric |
|
| emailAddress |
Required |
string |
|
| auditNotes |
Required |
string |
|
| applicationName |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| emailnotificationservice |
| [cfc44] component
components.emailService.emailNotificationService
|
| METHODS |
| CUSTOMEREMAILNOTIFICATION |
| function customerEmailNotification |
Arguments:
| Name |
Required |
Type |
Default |
| auditDescription |
Required |
string |
|
| auditContent |
Required |
string |
|
| emailSubject |
Required |
string |
|
| emailContent |
Required |
string |
|
| customerKey |
Required |
numeric |
|
| subjectDescription |
Required |
string |
|
| subjectKey |
Required |
numeric |
|
| emailSentTo |
Required |
string |
|
| emailSentFrom |
Required |
string |
|
| emailSentToCC |
Required |
string |
|
| emailSentToBC |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CUSTOMERMESSAGENOTIFICATION |
| function customerMessageNotification |
Arguments:
| Name |
Required |
Type |
Default |
| messageKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INVOICEEMAILCONFIRMATION |
| function invoiceEmailConfirmation |
Arguments:
| Name |
Required |
Type |
Default |
| invoiceLogKey |
Required |
numeric |
|
| adminOnly |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ORDEREMAILCONFIRMATION |
| function orderEmailConfirmation |
Arguments:
| Name |
Required |
Type |
Default |
| orderKey |
Required |
numeric |
|
| adminOnly |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| RETURNEDORDEREMAILCONFIRMATION |
| function returnedOrderEmailConfirmation |
Arguments:
| Name |
Required |
Type |
Default |
| orderKey |
Required |
numeric |
|
| adminOnly |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SENDCUSTOMERMESSAGENOTIFICATIONFROMBUTTON |
| function sendCustomerMessageNotificationFromButton |
Arguments:
| Name |
Required |
Type |
Default |
| messageKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SENDINVOICEEMAILCONFIRMATIONFROMBUTTON |
| function sendInvoiceEmailConfirmationFromButton |
Arguments:
| Name |
Required |
Type |
Default |
| orderKey |
Required |
numeric |
|
| adminOnly |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SENDORDEREMAILCONFIRMATIONFROMBUTTON |
| function sendOrderEmailConfirmationFromButton |
Arguments:
| Name |
Required |
Type |
Default |
| orderKey |
Required |
numeric |
|
| adminOnly |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SENDRETURNEDORDEREMAILCONFIRMATIONFROMBUTTON |
| function sendReturnedOrderEmailConfirmationFromButton |
Arguments:
| Name |
Required |
Type |
Default |
| orderKey |
Required |
numeric |
|
| adminOnly |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SYSTEMEMAILNOTIFICATION |
| function systemEmailNotification |
Arguments:
| Name |
Required |
Type |
Default |
| auditDescription |
Required |
string |
|
| auditContent |
Required |
string |
|
| emailSubject |
Required |
string |
|
| emailContent |
Required |
string |
|
| customerKey |
Required |
numeric |
|
| subjectDescription |
Required |
string |
|
| subjectKey |
Required |
numeric |
|
| emailSentTo |
Required |
string |
|
| emailSentFrom |
Required |
string |
|
| emailSentToCC |
Required |
string |
|
| emailSentToBC |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| emailreceiptisonbit |
1
|
| emailstoragedao |
| [cfc45] component
components.emailManager.emailStorageDAO
|
| METHODS |
| CREATEEMAILSTORAGE |
| function createEmailStorage |
Arguments:
| Name |
Required |
Type |
Default |
| emailStorageDate |
Required |
string |
|
| emailStorageFrom |
Required |
string |
|
| emailStorageMessageNumber |
Required |
string |
|
| emailStorageMessageID |
Required |
string |
|
| emailStorageReplyTo |
Required |
string |
|
| emailStorageSubject |
Required |
string |
|
| emailStorageCC |
Required |
string |
|
| emailStorageTo |
Required |
string |
|
| emailStorageBody |
Required |
string |
|
| emailStorageTextBody |
Required |
string |
|
| emailStorageHTMLBody |
Required |
string |
|
| emailStorageHeader |
Required |
string |
|
| emailStorageAttachments |
Required |
string |
|
| emailStorageAttachmentFiles |
Required |
string |
|
| emailStorageInsertedByUserFK |
Required |
numeric |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEEMAILSTORAGE |
| function deleteemailStorage |
Arguments:
| Name |
Required |
Type |
Default |
| emailStorageOBJ |
Required |
emailStorage |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETEMAILSTORAGE |
| function getemailStorage |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
emailStorage
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEEMAILSTORAGE |
| function updateemailStorage |
Arguments:
| Name |
Required |
Type |
Default |
| emailStorageOBJ |
Required |
emailStorage |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| emailstoragegateway |
| [cfc46] component
components.emailManager.emailStorageGateway
|
| METHODS |
| GETALLEMAILSTORAGE |
| function getAllemailStorage |
| Arguments: | none |
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETALLEMAILSTORAGEBYKEY |
| function getAllemailStorageByKey |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETBYATTRIBUTESQUERY |
| function getByAttributesQuery |
Arguments:
| Name |
Required |
Type |
Default |
| emailStorageAutoKey |
Optional |
numeric |
|
| emailStorageDate |
Optional |
string |
|
| emailStorageFrom |
Optional |
string |
|
| emailStorageMessageNumber |
Optional |
string |
|
| emailStorageMessageID |
Optional |
string |
|
| emailStorageReplyTo |
Optional |
string |
|
| emailStorageSubject |
Optional |
string |
|
| emailStorageCC |
Optional |
string |
|
| emailStorageTo |
Optional |
string |
|
| emailStorageBody |
Optional |
string |
|
| emailStorageTextBody |
Optional |
string |
|
| emailStorageHTMLBody |
Optional |
string |
|
| emailStorageHeader |
Optional |
string |
|
| emailStorageAttachments |
Optional |
string |
|
| emailStorageAttachmentFiles |
Optional |
string |
|
| emailStorageInsertDate |
Optional |
date |
|
| emailStorageInsertedByUserFK |
Optional |
numeric |
|
| orderby |
Optional |
string |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| encryptionkey |
w6lvfVMJawG2i0DWAwYBGw==
|
| environmentdao |
| [cfc47] component
components.environment.environmentDAO
|
| METHODS |
| GETENVIRONMENT |
| function getEnvironment |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
Environment
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEENVIRONMENT |
| function updateEnvironment |
Arguments:
| Name |
Required |
Type |
Default |
| EnvironmentOBJ |
Required |
Environment |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| environmentgateway |
| [cfc48] component
components.environment.environmentGateway
|
| METHODS |
| GETAPPLICATIONENVIRONMENT |
| function getApplicationEnvironment |
Arguments:
| Name |
Required |
Type |
Default |
| applicationName |
Required |
string |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETAPPLICATIONENVIRONMENTPATHING |
| function getApplicationEnvironmentPathing |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| applicationKey |
Required |
numeric |
|
| productionOrStaging |
Required |
numeric |
|
| pathTypeKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| environmentkey |
1
|
| environmenttempfilediskpath |
E:\WEB\mightecontent.com.v3\assets\temp\
|
| environmenttempfileurlpath |
/assets/temp/
|
| errorlogname |
Error Log: MECM
|
| errorlogstruct |
|
| errorreportingison |
1
|
| fileuploader |
| [cfc49] component
components.fileUploader.fileUploader
|
| METHODS |
| CHECKFORVALIDFILEEXTENTION |
| function checkForValidFileExtention |
Arguments:
| Name |
Required |
Type |
Default |
| fileExt |
Required |
string |
|
| extensionType |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| COPYIMAGEDISKFILE |
| function copyImageDiskFile |
Arguments:
| Name |
Required |
Type |
Default |
| originalDiskPath |
Required |
string |
|
| newDiskPath |
Required |
string |
|
| oldFileName |
Required |
string |
|
| newFileName |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CROPIMAGEROUTINE |
| function cropImageRoutine |
Arguments:
| Name |
Required |
Type |
Default |
| imageName |
Required |
string |
|
| originalPath |
Required |
string |
|
| destinationPath |
Required |
string |
|
| cropWidth |
Required |
numeric |
|
| cropHeight |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| OBJECTFOLDERMAINTENANCE |
| function objectFolderMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| objectKey |
Required |
numeric |
|
| originalCategoryKey |
Optional |
numeric |
|
| originalSecondaryCategoryKey |
Optional |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| RESIZEANDCROPCALCULATION |
| function resizeAndCropCalculation |
Arguments:
| Name |
Required |
Type |
Default |
| originalImageWidth |
Required |
numeric |
|
| originalImageHeight |
Required |
numeric |
|
| desiredImageWidth |
Required |
numeric |
|
| desiredImageHeight |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| RESIZETHISIMAGE |
| function resizeThisImage |
Arguments:
| Name |
Required |
Type |
Default |
| originalImagePath |
Required |
string |
|
| destinationImagePath |
Required |
string |
|
| resizeWidth |
Optional |
numeric |
|
| resizeHeight |
Optional |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| RESIZETHISIMAGETHUMBNAIL |
| function resizeThisImageThumbnail |
Arguments:
| Name |
Required |
Type |
Default |
| originalImagePath |
Required |
string |
|
| thumbnailDestinationImagePath |
Required |
string |
|
| resizeWidth |
Optional |
numeric |
|
| resizeHeight |
Optional |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| RESIZETHISIMAGETHUMBNAILCUSTOMSIZE |
| function resizeThisImageThumbnailCustomSize |
Arguments:
| Name |
Required |
Type |
Default |
| originalImagePath |
Required |
string |
|
| thumbnailDestinationImagePath |
Required |
string |
|
| height |
Required |
numeric |
|
| width |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPLOADCONTENTBUILDERFILE |
| function uploadContentBuilderFile |
Arguments:
| Name |
Required |
Type |
Default |
| imageNumber |
Required |
numeric |
|
| fileExt |
Required |
string |
|
| imageName |
Required |
string |
|
| imageBase364String |
Required |
string |
|
| imageCustomValue |
Required |
string |
|
| clientKey |
Required |
numeric |
|
| userKey |
Required |
numeric |
|
| imagePath |
Required |
string |
|
| imageURLPath |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPLOADFILE |
| function uploadFile |
Arguments:
| Name |
Required |
Type |
Default |
| fileUploadType |
Required |
numeric |
|
| userKey |
Required |
numeric |
|
| productKey |
Required |
numeric |
|
| clientKey |
Required |
numeric |
|
| temporaryFilePathAndName |
Required |
string |
|
| originalFileName |
Required |
string |
|
| uploadDiskPath |
Optional |
string |
|
| uploadURLPath |
Optional |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPLOADMEMBERIMAGEFILE |
| function uploadMemberImageFile |
Arguments:
| Name |
Required |
Type |
Default |
| imageNumber |
Required |
numeric |
|
| fileExt |
Required |
string |
|
| imageName |
Required |
string |
|
| imageBase364String |
Required |
string |
|
| customerKey |
Required |
numeric |
|
| clientKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| imagePath |
Required |
string |
|
| imageURLPath |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| galleryimagediskpath |
E:\WEB\mightecontent.com.v3\assets\custom\img\gallery\2\
|
| galleryimagemaximumheight |
878
|
| galleryimagemaximumwidth |
1170
|
| galleryimagethumbnailheight |
400
|
| galleryimagethumbnailwidth |
400
|
| galleryimageurlpath |
/assets/custom/img/gallery/2/
|
| gallerythumbnaildiskpath |
E:\WEB\mightecontent.com.v3\assets\custom\img\galleryThumbs\2\
|
| gallerythumbnailurlpath |
/assets/custom/img/galleryThumbs/2/
|
| genericloggingonbit |
1
|
| googlecalendarv3 |
| [cfc50] component
components.calendars.Google.GoogleCalendarV3
|
| METHODS |
| CALENDARS |
| function Calendars |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATECALENDAR |
| function CreateCalendar |
Arguments:
| Name |
Required |
Type |
Default |
| summary |
Required |
string |
[empty string] |
| description |
Optional |
Any |
|
| location |
Optional |
Any |
|
| timeZone |
Optional |
Any |
|
| resultType |
Optional |
string |
query |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Creates a secondary calendar |
| Description: |
|
|
|
| CREATEEVENT |
| function CreateEvent |
Arguments:
| Name |
Required |
Type |
Default |
| calendarId |
Required |
string |
|
| summary |
Required |
string |
|
| description |
Optional |
string |
|
| start |
Required |
date |
|
| end |
Required |
date |
|
| location |
Optional |
string |
|
| creator |
Optional |
struct |
|
| allday |
Optional |
boolean |
false |
| timeZone |
Optional |
string |
UTC |
| resultType |
Optional |
string |
query |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Adds an event. Returns Success or another message. |
| Description: |
|
|
|
| GETALLCALENDARS |
| function GetAllCalendars |
Arguments:
| Name |
Required |
Type |
Default |
| resultType |
Optional |
string |
query |
|
| ReturnType: |
ANY
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns all the calendars. |
| Description: |
|
|
|
| GETALLEVENTS |
| function getAllEvents |
Arguments:
| Name |
Required |
Type |
Default |
| calendarId |
Required |
string |
|
| resultType |
Optional |
string |
query |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Gets events. |
| Description: |
|
|
|
| GETCALENDAR |
| function GetCalendar |
Arguments:
| Name |
Required |
Type |
Default |
| calendarId |
Optional |
string |
[empty string] |
| resultType |
Optional |
string |
query |
|
| ReturnType: |
ANY
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns all the calendars. |
| Description: |
|
|
|
| GETEVENT |
| function GetEvent |
Arguments:
| Name |
Required |
Type |
Default |
| calendarId |
Required |
string |
|
| eventId |
Required |
string |
|
| resultType |
Optional |
string |
query |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns an event |
| Description: |
|
|
|
| GETEVENTS |
| function getEvents |
Arguments:
| Name |
Required |
Type |
Default |
| calendarId |
Required |
string |
|
| resultType |
Optional |
string |
query |
| maxResults |
Optional |
numeric |
|
| orderBy |
Optional |
string |
|
| timeMin |
Optional |
date |
|
| timeMax |
Optional |
date |
|
| singleEvents |
Optional |
boolean |
|
| q |
Optional |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns events on the specified calendar |
| Description: |
|
|
|
| INIT |
| function init |
Arguments:
| Name |
Required |
Type |
Default |
| oauth2 |
Required |
ANY |
|
| baseAPIEndpoint |
Optional |
string |
https://www.googleapis.com/calendar/v3 |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
The constructor method. |
| Description: |
|
|
|
| REMOVEALLEVENTS |
| function removeAllEvents |
Arguments:
| Name |
Required |
Type |
Default |
| calendarId |
Required |
string |
|
| resultType |
Optional |
string |
none |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| REMOVECALENDAR |
| function RemoveCalendar |
Arguments:
| Name |
Required |
Type |
Default |
| calendarId |
Required |
string |
|
| resultType |
Optional |
string |
none |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
Deletes a secondary calendar |
| Description: |
|
|
|
| REMOVEEVENT |
| function RemoveEvent |
Arguments:
| Name |
Required |
Type |
Default |
| calendarId |
Required |
string |
|
| eventId |
Optional |
string |
none |
| resultType |
Optional |
string |
none |
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
Deletes a secondary calendar |
| Description: |
|
|
|
| UPDATECALENDAR |
| function UpdateCalendar |
Arguments:
| Name |
Required |
Type |
Default |
| summary |
Optional |
string |
|
| description |
Optional |
Any |
|
| location |
Optional |
Any |
|
| timeZone |
Optional |
Any |
|
| etag |
Optional |
string |
|
| resultType |
Optional |
string |
query |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Creates a secondary calendar |
| Description: |
|
|
|
| UPDATEEVENT |
| function UpdateEvent |
Arguments:
| Name |
Required |
Type |
Default |
| calendarId |
Required |
string |
|
| eventId |
Required |
string |
|
| summary |
Required |
string |
|
| description |
Optional |
string |
|
| start |
Required |
date |
|
| end |
Required |
date |
|
| location |
Optional |
string |
|
| creator |
Optional |
struct |
|
| allday |
Optional |
boolean |
false |
| timeZone |
Optional |
string |
UTC |
| sequence |
Optional |
numeric |
0 |
| resultType |
Optional |
string |
query |
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Adds an event. Returns Success or another message. |
| Description: |
|
|
|
|
|
| googlemapskey |
ABQIAAAAMmnIw2Cnoiq5kviDAZFRpBTMB2eQUOuRQi6e5l0RJ5S6rD1FIRRzjnLz3Mf1RJ_HVf71qgJXib1ShQ
|
| groupsdao |
| [cfc51] component
components.groups.groupsDAO
|
| METHODS |
| CREATEGROUPS |
| function createGroups |
Arguments:
| Name |
Required |
Type |
Default |
| GroupsOBJ |
Required |
Groups |
|
|
| ReturnType: |
Groups
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEGROUPS |
| function deleteGroups |
Arguments:
| Name |
Required |
Type |
Default |
| GroupsOBJ |
Required |
Groups |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETGROUPS |
| function getGroups |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
Groups
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEGROUPS |
| function updateGroups |
Arguments:
| Name |
Required |
Type |
Default |
| GroupsOBJ |
Required |
Groups |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| groupsservice |
| [cfc52] component
components.groups.groupsService
|
| METHODS |
| DELETEGROUPSUBTYPE |
| function deleteGroupSubType |
Arguments:
| Name |
Required |
Type |
Default |
| groupSubTypeKey |
Required |
numeric |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEGROUPTYPE |
| function deleteGroupType |
Arguments:
| Name |
Required |
Type |
Default |
| groupTypeKey |
Required |
numeric |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETALLGROUPS |
| function getAllGroups |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| groupTypeKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETALLGROUPSINJSON |
| function getAllGroupsInJSON |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| groupTypeKey |
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: |
|
|
|
| GETALLGROUPSUBTYPELEADERS |
| function getAllGroupSubTypeLeaders |
Arguments:
| Name |
Required |
Type |
Default |
| groupKey |
Required |
numeric |
|
| groupSubTypeKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETALLGROUPSUBTYPES |
| function getAllGroupSubTypes |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| groupTypeKey |
Required |
numeric |
|
| groupKey |
Required |
numeric |
|
| groupSubTypeKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETALLGROUPSUBTYPESINJSON |
| function getAllGroupSubTypesInJSON |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| groupTypeKey |
Required |
numeric |
|
| groupKey |
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: |
|
|
|
| GETALLGROUPTYPES |
| function getAllGroupTypes |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| groupTypeKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETALLGROUPTYPESINJSON |
| function getAllGroupTypesInJSON |
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: |
|
|
|
| GETGROUPMEMBERSBYGROUPKEY |
| function getGroupMembersByGroupKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| groupKey |
Required |
numeric |
|
| groupSubjectTypeKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETGROUPMEMBERSBYGROUPKEYFORDISPLAY |
| function getGroupMembersByGroupKeyForDisplay |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| groupKey |
Required |
numeric |
|
| groupSubjectTypeKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETGROUPMEMBERSBYGROUPTYPEKEY |
| function getGroupMembersByGroupTypeKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| groupTypeKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETGROUPMEMBERSKEYLISTBYGROUPKEY |
| function getGroupMembersKeyLISTByGroupKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| groupKey |
Required |
numeric |
|
| groupSubjectTypeKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETGROUPMEMBERSKEYLISTBYGROUPKEYANDGROUPTYPEKEY |
| function getGroupMembersKeyLISTByGroupKeyAndGroupTypeKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| groupKey |
Required |
numeric |
|
| groupSubjectTypeKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETGROUPSUBTYPE |
| function getGroupSubType |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| groupTypeKey |
Required |
numeric |
|
| groupKey |
Required |
numeric |
|
| groupSubTypeKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCUSTOMERDROPDOWNFORGROUPS |
| function insertCustomerDropdownForGroups |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| membersOnly |
Required |
numeric |
|
| class |
Optional |
string |
|
| defaultValue |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCUSTOMERSMULTIDROPDOWNFORGROUPS |
| function insertCustomersMultiDropdownForGroups |
Arguments:
| Name |
Required |
Type |
Default |
| membersOnly |
Required |
boolean |
|
| customerTypeKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| selectedLIST |
Required |
string |
|
| class |
Optional |
string |
|
| selectSize |
Optional |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTGROUPTYPEDROPDOWN |
| function insertGroupTypeDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| clientKey |
Required |
numeric |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| MAINTAINGROUPHASH |
| function maintainGroupHash |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| groupKey |
Required |
numeric |
|
| groupSubjectKey |
Required |
numeric |
|
| memberKeyLIST |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| MAINTAINGROUPSUBTYPELEADER |
| function maintainGroupSubTypeLeader |
Arguments:
| Name |
Required |
Type |
Default |
| sessionUserKey |
Required |
numeric |
|
| groupSubjectKey |
Required |
numeric |
|
| groupMemberKey |
Required |
numeric |
|
| groupLeaderTypeKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SAVEGROUPSUBTYPE |
| function saveGroupSubType |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| groupSubTypeKey |
Required |
numeric |
|
| groupKey |
Required |
numeric |
|
| groupSubTypeDescription |
Required |
string |
|
| groupSubTypeDetails |
Required |
string |
|
| groupSubTypeIsActiveBit |
Required |
boolean |
|
| sessionUserKey |
Required |
numeric |
|
| groupSubTypeSortOrder |
Required |
numeric |
|
| groupSubjectTypeBreakOutBit |
Required |
boolean |
|
| groupSubjectTypeRowDescription |
Required |
string |
|
| groupSubjectTypeHasChairBit |
Required |
boolean |
|
| groupSubjectTypeHasAssistantChairBit |
Required |
boolean |
|
| groupSubjectTypeHasCoChairBit |
Required |
boolean |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SAVEGROUPTYPE |
| function saveGroupType |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| groupTypeKey |
Required |
numeric |
|
| groupTypeDescription |
Required |
string |
|
| groupTypeIsActiveBit |
Required |
boolean |
|
| sessionUserKey |
Required |
numeric |
|
| groupTypeIsProtected |
Required |
numeric |
|
| groupTypeSortOrder |
Required |
numeric |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| image |
| [cfc53] component
components.imageManager.image
|
| METHODS |
| ADDTEXT |
| function addText |
Arguments:
| Name |
Required |
Type |
Default |
| objImage |
Required |
Any |
|
| inputFile |
Required |
string |
|
| outputFile |
Required |
string |
|
| x |
Required |
numeric |
|
| y |
Required |
numeric |
|
| fontDetails |
Required |
struct |
|
| content |
Required |
String |
|
| jpegCompression |
Optional |
numeric |
[runtime expression] |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Add text to an image. |
| Description: |
|
|
|
| CONVERT |
| function convert |
Arguments:
| Name |
Required |
Type |
Default |
| objImage |
Required |
Any |
|
| inputFile |
Required |
string |
|
| outputFile |
Required |
string |
|
| jpegCompression |
Optional |
numeric |
[runtime expression] |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Convert an image from one format to another. |
| Description: |
|
|
|
| CROP |
| function crop |
Arguments:
| Name |
Required |
Type |
Default |
| objImage |
Required |
Any |
|
| inputFile |
Required |
string |
|
| outputFile |
Required |
string |
|
| fromX |
Required |
numeric |
|
| fromY |
Required |
numeric |
|
| newWidth |
Required |
numeric |
|
| newHeight |
Required |
numeric |
|
| jpegCompression |
Optional |
numeric |
[runtime expression] |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Crop an image. |
| Description: |
|
|
|
| FILTERFASTBLUR |
| function filterFastBlur |
Arguments:
| Name |
Required |
Type |
Default |
| objImage |
Required |
Any |
|
| inputFile |
Required |
string |
|
| outputFile |
Required |
string |
|
| blurAmount |
Required |
numeric |
|
| iterations |
Required |
numeric |
|
| jpegCompression |
Optional |
numeric |
[runtime expression] |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Internal method used for flipping and flopping images. |
| Description: |
|
|
|
| FILTERPOSTERIZE |
| function filterPosterize |
Arguments:
| Name |
Required |
Type |
Default |
| objImage |
Required |
Any |
|
| inputFile |
Required |
string |
|
| outputFile |
Required |
string |
|
| amount |
Required |
string |
|
| jpegCompression |
Optional |
numeric |
[runtime expression] |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Internal method used for flipping and flopping images. |
| Description: |
|
|
|
| FILTERSHARPEN |
| function filterSharpen |
Arguments:
| Name |
Required |
Type |
Default |
| objImage |
Required |
Any |
|
| inputFile |
Required |
string |
|
| outputFile |
Required |
string |
|
| jpegCompression |
Optional |
numeric |
[runtime expression] |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Internal method used for flipping and flopping images. |
| Description: |
|
|
|
| FLIPHORIZONTAL |
| function flipHorizontal |
Arguments:
| Name |
Required |
Type |
Default |
| objImage |
Required |
Any |
|
| inputFile |
Required |
string |
|
| outputFile |
Required |
string |
|
| jpegCompression |
Optional |
numeric |
[runtime expression] |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Flip an image horizontally. |
| Description: |
|
|
|
| FLIPVERTICAL |
| function flipVertical |
Arguments:
| Name |
Required |
Type |
Default |
| objImage |
Required |
Any |
|
| inputFile |
Required |
string |
|
| outputFile |
Required |
string |
|
| jpegCompression |
Optional |
numeric |
[runtime expression] |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Flop an image vertically. |
| Description: |
|
|
|
| GETIMAGEINFO |
| function getImageInfo |
Arguments:
| Name |
Required |
Type |
Default |
| objImage |
Required |
Any |
|
| inputFile |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Rotate an image (+/-)90, (+/-)180, or (+/-)270 degrees. |
| Description: |
|
|
|
| GETOPTION |
| function getOption |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
string |
|
|
| ReturnType: |
any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Returns the current value for the specified CFC option. |
| Description: |
|
|
|
| READIMAGE |
| function readImage |
Arguments:
| Name |
Required |
Type |
Default |
| source |
Required |
string |
|
| forModification |
Optional |
boolean |
yes |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Reads an image from a local file. Requires an absolute path. |
| Description: |
|
|
|
| RESIZE |
| function resize |
Arguments:
| Name |
Required |
Type |
Default |
| objImage |
Required |
Any |
|
| inputFile |
Required |
string |
|
| outputFile |
Required |
string |
|
| newWidth |
Required |
numeric |
|
| newHeight |
Required |
numeric |
|
| preserveAspect |
Optional |
boolean |
FALSE |
| cropToExact |
Optional |
boolean |
FALSE |
| jpegCompression |
Optional |
numeric |
[runtime expression] |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Resize an image to a specific width and height. |
| Description: |
|
|
|
| ROTATE |
| function rotate |
Arguments:
| Name |
Required |
Type |
Default |
| objImage |
Required |
Any |
|
| inputFile |
Required |
string |
|
| outputFile |
Required |
string |
|
| degrees |
Required |
numeric |
|
| jpegCompression |
Optional |
numeric |
[runtime expression] |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Rotate an image (+/-)90, (+/-)180, or (+/-)270 degrees. |
| Description: |
|
|
|
| SCALEHEIGHT |
| function scaleHeight |
Arguments:
| Name |
Required |
Type |
Default |
| objImage |
Required |
Any |
|
| inputFile |
Required |
string |
|
| outputFile |
Required |
string |
|
| newHeight |
Required |
numeric |
|
| jpegCompression |
Optional |
numeric |
[runtime expression] |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Scale an image to a specific height. |
| Description: |
|
|
|
| SCALEWIDTH |
| function scaleWidth |
Arguments:
| Name |
Required |
Type |
Default |
| objImage |
Required |
Any |
|
| inputFile |
Required |
string |
|
| outputFile |
Required |
string |
|
| newWidth |
Required |
numeric |
|
| jpegCompression |
Optional |
numeric |
[runtime expression] |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Scale an image to a specific width. |
| Description: |
|
|
|
| SETOPTION |
| function setOption |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
string |
|
| val |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Sets values for allowed CFC options. |
| Description: |
|
|
|
| WATERMARK |
| function watermark |
Arguments:
| Name |
Required |
Type |
Default |
| objImage1 |
Required |
Any |
|
| objImage2 |
Required |
Any |
|
| inputFile1 |
Required |
string |
|
| inputFile2 |
Required |
string |
|
| alpha |
Required |
numeric |
|
| placeAtX |
Required |
numeric |
|
| placeAtY |
Required |
numeric |
|
| outputFile |
Required |
string |
|
| jpegCompression |
Optional |
numeric |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| WRITEIMAGE |
| function writeImage |
Arguments:
| Name |
Required |
Type |
Default |
| outputFile |
Required |
string |
|
| img |
Required |
any |
|
| jpegCompression |
Optional |
numeric |
[runtime expression] |
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Write an image to disk. |
| Description: |
|
|
|
|
|
| imagedefaultcropheight |
300
|
| imagedefaultcropwidth |
350
|
| imagemanagergateway |
| [cfc54] component
components.imageManager.imageManagerGateway
|
| METHODS |
| GETIMAGEINFORMATION |
| function getImageInformation |
Arguments:
| Name |
Required |
Type |
Default |
| completeFilePath |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Get All customers |
| Description: |
|
|
|
| RUNCMYKIMAGECONVERSION |
| function runCmykImageConversion |
Arguments:
| Name |
Required |
Type |
Default |
| completeFilePath |
Required |
string |
|
| newPathAndFileName |
Required |
string |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Get All customers |
| Description: |
|
|
|
| RUNIMAGERESIZE |
| function runImageResize |
Arguments:
| Name |
Required |
Type |
Default |
| completeFilePath |
Required |
string |
|
| newPathAndFileName |
Required |
string |
|
| pixelResize |
Required |
numeric |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Get All customers |
| Description: |
|
|
|
| UPLOADANDRESIZEIMAGE |
| function uploadAndResizeImage |
Arguments:
| Name |
Required |
Type |
Default |
| imageTargetFileName |
Required |
string |
|
| destinationPath |
Required |
string |
|
| destinationFileName |
Required |
string |
|
| resizeImage |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| imagemaximumfilesize |
5000
|
| imagemaximumheight |
768
|
| imagemaximumwidth |
1074
|
| imagethumbnailheight |
300
|
| imagethumbnailwidth |
300
|
| issubclient |
0
|
| issubclientofclientkey |
1
|
| joblistingsdao |
| [cfc55] component
components.jobListings.jobListingsDAO
|
| METHODS |
| CREATEJOBLISTINGS |
| function createjobListings |
Arguments:
| Name |
Required |
Type |
Default |
| jobListingsOBJ |
Required |
jobListings |
|
|
| ReturnType: |
jobListings
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEJOBLISTINGS |
| function deletejobListings |
Arguments:
| Name |
Required |
Type |
Default |
| jobListingsOBJ |
Required |
jobListings |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETJOBLISTINGS |
| function getjobListings |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
jobListings
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEJOBLISTINGS |
| function updatejobListings |
Arguments:
| Name |
Required |
Type |
Default |
| jobListingsOBJ |
Required |
jobListings |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| joblistingsservice |
| [cfc56] component
components.jobListings.jobListingsService
|
| METHODS |
| GETALLACTIVEJOBLISTINGS |
| function getAllActiveJobListings |
| Arguments: | none |
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETATTACHMENTSBYJOBLISTINGKEY |
| function getAttachmentsByJobListingKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| jobListingKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETJOBDETAIL |
| function getJobDetail |
Arguments:
| Name |
Required |
Type |
Default |
| jobListingKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETJOBLISTINGBYKEY |
| function getJobListingByKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| jobListingKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETJOBLISTINGCARDS |
| function getJobListingCards |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| categoryKeyLIST |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETJOBLISTINGDETAILCARD |
| function getJobListingDetailCard |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| jobListingKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETJOBLISTINGSBYCATEGORYLIST |
| function getJobListingsByCategoryLIST |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| categoryKeyLIST |
Required |
string |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETJOBLISTINGSINJSON |
| function getJobListingsInJSON |
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: |
|
|
|
| GETLASTACTIVEJOBLISTINGS |
| function getLastActiveJobListings |
Arguments:
| Name |
Required |
Type |
Default |
| listingCount |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMEMBERJOBLISTINGS |
| function getMemberJobListings |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTJOBLISTINGCATEGORYMULTISELECT |
| function insertJobListingCategoryMultiSelect |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| jobListingKey |
Required |
numeric |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a slushbox html |
| Description: |
|
|
|
| UPDATECATEGORYHASH |
| function updateCategoryHash |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| subjectTypeKey |
Required |
numeric |
|
| subjectKey |
Required |
numeric |
|
| categoriesLIST |
Required |
string |
|
| userKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| maintenanceloggingonbit |
1
|
| mappointicondiskpath |
E:\WEB\mightecontent.com.v3\assets\custom\icons\
|
| mappointiconurlpath |
/assets/custom/icons/
|
| maxuploadimagegroupsize |
128000
|
| maxuploadimagesize |
256000
|
| mecm_emailbccto |
mike@snazzo.com
|
| mecm_emailcc |
mike@snazzo.com
|
| mecm_emailfailto |
MightESolutions <server@snazzomail.com>
|
| mecm_emailfrom |
MightESolutions <server@snazzomail.com>
|
| mecm_emailmailserver |
mail.snazzomail.com
|
| mecm_emailmailserverpassword |
5b47CR9a100!
|
| mecm_emailmailserverusername |
server@snazzomail.com
|
| mecm_emailport |
587
|
| mecm_emailreplyto |
MightESolutions <server@snazzomail.com>
|
| mecm_emailsslyesno |
0
|
| mecm_emailtlsyesno |
0
|
| mecm_erroremailaddressfrom |
MightESolutions <server@snazzomail.com>
|
| mecm_errorsendemailto |
mike@snazzo.com
|
| mecm_generalinfoemailaddress |
MightESolutions <server@snazzomail.com>
|
| metaauthor |
Michael Smilonich
|
| mightecartbaseurl |
[empty string]
|
| mightecartclientkey |
1
|
| mightecartdatasource |
MightECartDatasource
|
| mightecartservice |
| [cfc57] component
components.remoteService.mightECartService
|
| METHODS |
| GETCLIENTCUSTOMERDIRECTORYCHOICES |
| function getClientCustomerDirectoryChoices |
| Arguments: | none |
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCUSTOMERBIOMODALCONTENT |
| function getCustomerBioModalContent |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETDIRECTORYBYCLIENTCUSTOMERDIRECTORYHASH |
| function getDirectoryByClientCustomerDirectoryHash |
Arguments:
| Name |
Required |
Type |
Default |
| customerTypeKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETINDIVIDUALMEMBERSPOTLIGHTFORDISPLAY |
| function getIndividualMemberSpotlightForDisplay |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| memberKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETINDIVIDUALMEMBERSPOTLIGHTFORSIDEBAR |
| function getIndividualMemberSpotlightForSidebar |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| selectedMemberKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMEMBERSHIPDIRECTORY |
| function getMembershipDirectory |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| customerTypeKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMEMBERSPOTLIGHTFORDISPLAY |
| function getMemberSpotlightForDisplay |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMIGHTECARTAD |
| function getMightECartAd |
Arguments:
| Name |
Required |
Type |
Default |
| mightECartClientKey |
Required |
numeric |
|
| adKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMIGHTECARTADLOCATIONS |
| function getMightECartAdLocations |
Arguments:
| Name |
Required |
Type |
Default |
| adLocationKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMIGHTECARTADS |
| function getMightECartAds |
Arguments:
| Name |
Required |
Type |
Default |
| mightECartClientKey |
Required |
numeric |
|
| adLocationKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMIGHTECARTEVENTFEED |
| function getMightECartEventFeed |
Arguments:
| Name |
Required |
Type |
Default |
| mightECartClientKey |
Required |
numeric |
|
| numberOfEventRecords |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMIGHTECARTEVENTFEEDBYCATGEGORY |
| function getMightECartEventFeedByCatgegory |
Arguments:
| Name |
Required |
Type |
Default |
| mightECartClientKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
| numberOfEventRecords |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMIGHTECARTPASTEVENTS |
| function getMightECartPastEvents |
| Arguments: | none |
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMIGHTECARTPRODUCTFEED |
| function getMightECartProductFeed |
Arguments:
| Name |
Required |
Type |
Default |
| mightECartClientKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
| numberOfEventRecords |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMIGHTECARTPRODUCTFEEDCATEGORYSUBCATEGORY |
| function getMightECartProductFeedCategorySubcategory |
Arguments:
| Name |
Required |
Type |
Default |
| mightECartClientKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
| subCategoryKey |
Required |
numeric |
|
| numberOfEventRecords |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SAVEMIGHTECARTAD |
| function saveMightECartAd |
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: |
|
|
|
|
|
| mightedocscontentbuilderblocksurlpath |
/shared-assets/plugins/content-builder/content-builder-blocks/
|
| mightedocscontentbuilderurlpath |
/shared-assets/plugins/content-builder/content-builder-4.1/
|
| mightedocsdiskpath |
E:\WEB\mightecontent.com.v3\mightedocs\img\2\
|
| mightedocsurlpath |
/mightedocs/img/2/
|
| mighteletterclientkey |
2
|
| mightepropertybaseurl |
[empty string]
|
| mightepropertyclientkey |
1
|
| mightepropertydatasource |
MightEPropertyDatasource
|
| mightepropertyservice |
| [cfc58] component
components.remoteService.mightEPropertyService
|
| METHODS |
| GETMIGHTEPROPERTYEVENTFEED |
| function getMightEPropertyEventFeed |
Arguments:
| Name |
Required |
Type |
Default |
| mightEPropertyClientKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
| numberOfEventRecords |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMIGHTEPROPERTYPRODUCTCATEGORYDETAILS |
| function getMightEPropertyProductCategoryDetails |
Arguments:
| Name |
Required |
Type |
Default |
| mightEPropertyClientKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPROPERTIESFORMAPPINGINXML |
| function getPropertiesForMappingInXML |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPROPERTIESWITHGEOLOCATION |
| function getPropertiesWithGeoLocation |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPROPERTYFEEDBYLOCATIONKEY |
| function getPropertyFeedByLocationkey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| locationKey |
Required |
numeric |
|
| numberOfPropertyRecords |
Required |
numeric |
|
| numberOfImageRecords |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| mightetrackclientkey |
1
|
| mighteventbaseurl |
http://demo.mightevent.com
|
| mighteventclientkey |
2
|
| mighteventdatasource |
MightEventDatasource
|
| mighteventdomainname |
beta.mightecontent.com
|
| mighteventservice |
| [cfc59] component
components.remoteService.mightEventService
|
| METHODS |
| GETCUSTOMERBIOMODALCONTENT |
| function getCustomerBioModalContent |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMIGHTEVENTAD |
| function getMightEventAd |
Arguments:
| Name |
Required |
Type |
Default |
| mightEventClientKey |
Required |
numeric |
|
| adKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMIGHTEVENTADCONTENTBYLOCATIONKEY |
| function getMightEventAdContentByLocationKey |
Arguments:
| Name |
Required |
Type |
Default |
| mightEventClientKey |
Required |
numeric |
|
| adLocationKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMIGHTEVENTADLOCATIONS |
| function getMightEventAdLocations |
| Arguments: | none |
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMIGHTEVENTADS |
| function getMightEventAds |
Arguments:
| Name |
Required |
Type |
Default |
| mightEventClientKey |
Required |
numeric |
|
| adLocationKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMIGHTEVENTEVENTFEED |
| function getMightEventEventFeed |
Arguments:
| Name |
Required |
Type |
Default |
| mightEventClientKey |
Required |
numeric |
|
| numberOfEventRecords |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETMIGHTEVENTPASTEVENTS |
| function getMightEventPastEvents |
| Arguments: | none |
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SAVEMIGHTEVENTAD |
| function saveMightEventAd |
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: |
|
|
|
|
|
| newsarticlesdao |
| [cfc60] component
components.newsArticles.newsArticlesDAO
|
| METHODS |
| CREATENEWSARTICLES |
| function createNewsArticles |
Arguments:
| Name |
Required |
Type |
Default |
| NewsArticlesOBJ |
Required |
NewsArticles |
|
|
| ReturnType: |
NewsArticles
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETENEWSARTICLES |
| function deleteNewsArticles |
Arguments:
| Name |
Required |
Type |
Default |
| NewsArticlesOBJ |
Required |
NewsArticles |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETNEWSARTICLES |
| function getNewsArticles |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
NewsArticles
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATENEWSARTICLES |
| function updateNewsArticles |
Arguments:
| Name |
Required |
Type |
Default |
| NewsArticlesOBJ |
Required |
NewsArticles |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| newsarticlesservice |
| [cfc61] component
components.newsArticles.newsArticlesService
|
| METHODS |
| DELETENEWSARTICLE |
| function deleteNewsArticle |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| newsArticleKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETNEWSARTICLE |
| function getNewsArticle |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| newsArticleKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETNEWSARTICLECONTENT |
| function getNewsArticleContent |
Arguments:
| Name |
Required |
Type |
Default |
| newsArticleKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETNEWSARTICLESBYCATEGORYANDSUBCATEGORY_JSON_PAGINATED |
| function getNewsArticlesByCategoryAndSubCategory_JSON_Paginated |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| categoryTypeKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
| subCategoryKey |
Required |
numeric |
|
| rowStart |
Required |
numeric |
|
| returnNumberOfRows |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETNEWSARTICLESBYCATEGORYSUBCATEGORY |
| function getNewsArticlesByCategorySubCategory |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| categoryTypeKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
| subCategoryKey |
Required |
numeric |
|
| numberOfRows |
Required |
numeric |
|
| excludeLinkOnly |
Optional |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETNEWSARTICLESBYLOCATION |
| function getNewsArticlesByLocation |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| locationKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
| numberOfRows |
Required |
numeric |
|
| excludeLinkOnly |
Optional |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETNEWSARTICLESBYPATH |
| function getNewsArticlesByPath |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| locationPath |
Required |
string |
|
| categoryKey |
Required |
numeric |
|
| numberOfRows |
Required |
numeric |
|
| excludeLinkOnly |
Optional |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETNEWSARTICLESBYPATH_JSON_PAGINATED |
| function getNewsArticlesByPath_JSON_Paginated |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| categoryTypeKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
| locationKey |
Required |
numeric |
|
| locationPath |
Required |
string |
|
| rowStart |
Required |
numeric |
|
| returnNumberOfRows |
Required |
numeric |
|
| excludeLinkOnly |
Optional |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETNEWSARTICLESINJSON |
| function getNewsArticlesInJSON |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
| SubCategoryKey |
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: |
|
|
|
| GETNEWSCATEGORIESINJSON |
| function getNewsCategoriesInJSON |
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: |
|
|
|
| GETNEWSCATEGORYLOCATIONSINJSON |
| function getNewsCategoryLocationsInJSON |
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: |
|
|
|
| GETPAGEARTICLESLIST |
| function getPageArticlesList |
Arguments:
| Name |
Required |
Type |
Default |
| newsArticleKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTFILTERBYCATEGORYDROPDOWN |
| function insertFilterByCategoryDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| categoryKey |
Required |
numeric |
|
| subCategoryKey |
Required |
numeric |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a dropdown of categories |
| Description: |
|
|
|
| INSERTNEWSARTICLEAUTHORS |
| function insertNewsArticleAuthors |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a dropdown |
| Description: |
|
|
|
| INSERTNEWSARTICLECATEGORYMULTISELECT |
| function insertNewsArticleCategoryMultiSelect |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| newsArticleKey |
Required |
numeric |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a slushbox html |
| Description: |
|
|
|
| INSERTNEWSCATEGORYDROPDOWN |
| function insertNewsCategoryDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a dropdown |
| Description: |
|
|
|
| INSERTNEWSCATEGORYLOCATIONDROPDOWN |
| function insertNewsCategoryLocationDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a dropdown |
| Description: |
|
|
|
| UPDATEARTICLEACTIVESTATUS |
| function updateArticleActiveStatus |
Arguments:
| Name |
Required |
Type |
Default |
| action |
Required |
boolean |
|
| articleKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEARTICLESORTORDER |
| function updateArticleSortOrder |
Arguments:
| Name |
Required |
Type |
Default |
| newPosition |
Required |
numeric |
|
| articleKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATENEWSARTICLE |
| function updateNewsArticle |
Arguments:
| Name |
Required |
Type |
Default |
| newsArticleKey |
Required |
numeric |
|
| newsArticleHTML |
Required |
string |
|
| newsArticleMainCSS |
Required |
string |
|
| newsArticleSectionCSS |
Required |
string |
|
| sessionUserKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| newscategoriesdao |
| [cfc62] component
components.newsArticles.newsCategoriesDAO
|
| METHODS |
| CREATENEWSCATEGORIES |
| function createNewsCategories |
Arguments:
| Name |
Required |
Type |
Default |
| NewsCategoriesOBJ |
Required |
NewsCategories |
|
|
| ReturnType: |
NewsCategories
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETENEWSCATEGORIES |
| function deleteNewsCategories |
Arguments:
| Name |
Required |
Type |
Default |
| NewsCategoriesOBJ |
Required |
NewsCategories |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETNEWSCATEGORIES |
| function getNewsCategories |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
NewsCategories
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATENEWSCATEGORIES |
| function updateNewsCategories |
Arguments:
| Name |
Required |
Type |
Default |
| NewsCategoriesOBJ |
Required |
NewsCategories |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| newscategorylocationsdao |
| [cfc63] component
components.newsArticles.newsCategoryLocationsDAO
|
| METHODS |
| CREATENEWSCATEGORYLOCATIONS |
| function createNewsCategoryLocations |
Arguments:
| Name |
Required |
Type |
Default |
| NewsCategoryLocationsOBJ |
Required |
NewsCategoryLocations |
|
|
| ReturnType: |
NewsCategoryLocations
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETENEWSCATEGORYLOCATIONS |
| function deleteNewsCategoryLocations |
Arguments:
| Name |
Required |
Type |
Default |
| NewsCategoryLocationsOBJ |
Required |
NewsCategoryLocations |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETNEWSCATEGORYLOCATIONS |
| function getNewsCategoryLocations |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
NewsCategoryLocations
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATENEWSCATEGORYLOCATIONS |
| function updateNewsCategoryLocations |
Arguments:
| Name |
Required |
Type |
Default |
| NewsCategoryLocationsOBJ |
Required |
NewsCategoryLocations |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| numberofrowsforsidebar |
3
|
| oauth2 |
| [cfc64] component
components.oAuth.oAuth2
|
| METHODS |
| GETACCESS_TOKEN |
| function GetAccess_token |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
getter for oauth access_token |
| Description: |
|
|
|
| GETACCESSTOKEN |
| function GetAccessToken |
Arguments:
| Name |
Required |
Type |
Default |
| code |
Required |
string |
|
|
| ReturnType: |
Struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
This method exchanges the authorization code for an access token and (where present) a refresh token. |
| Description: |
|
|
|
| GETLOGINURL |
| function GetLoginURL |
| Arguments: | none |
| ReturnType: |
String
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I generate the link to login and retrieve the authentication code. |
| Description: |
|
|
|
| GETREDIRECT_URI |
| function GetRedirect_uri |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
getter for oauth redirect_uri |
| Description: |
|
|
|
| GETREFRESH_TOKEN |
| function GetRefresh_token |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
getter for oauth refresh_token |
| Description: |
|
|
|
| GETTOKENSTRUCT |
| function GetTokenStruct |
| Arguments: | none |
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
returns the oauth token structure |
| Description: |
|
|
|
| INIT |
| function Init |
Arguments:
| Name |
Required |
Type |
Default |
| client_id |
Required |
string |
|
| client_secret |
Required |
string |
|
| redirect_uri |
Required |
string |
|
| scope |
Required |
string |
|
| state |
Required |
string |
|
| access_type |
Optional |
string |
online |
| approval_prompt |
Optional |
string |
auto |
| base_auth_endpoint |
Optional |
string |
https://accounts.google.com/o/oauth2/ |
| token_storage |
Required |
string |
session |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
The constructor method. |
| Description: |
|
|
|
| ISAUTH |
| function IsAuth |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
returns true if the access_token exists and has not expired |
| Description: |
|
|
|
| ISREFRESH |
| function IsRefresh |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
returns whether a refresh token exists |
| Description: |
|
|
|
| REFRESHTOKEN |
| function RefreshToken |
| Arguments: | none |
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I take the refresh_token from the authorization procedure and get you a new access token. |
| Description: |
|
|
|
| REVOKEACCESS |
| function RevokeAccess |
Arguments:
| Name |
Required |
Type |
Default |
| token |
Required |
string |
[runtime expression] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
I revoke access to this application. You must pass in either the refresh token or access token. |
| Description: |
|
|
|
| SETREFRESH_TOKEN |
| function SetRefresh_token |
Arguments:
| Name |
Required |
Type |
Default |
| refresh_token |
Required |
string |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
setter for oauth refresh_token |
| Description: |
|
|
|
|
|
| objectcategorydao |
| [cfc65] component
components.objects.objectCategoryDAO
|
| METHODS |
| CREATEOBJECTCATEGORY |
| function createobjectCategory |
Arguments:
| Name |
Required |
Type |
Default |
| objectCategoryOBJ |
Required |
objectCategory |
|
|
| ReturnType: |
objectCategory
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEOBJECTCATEGORY |
| function deleteobjectCategory |
Arguments:
| Name |
Required |
Type |
Default |
| objectCategoryOBJ |
Required |
objectCategory |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETOBJECTCATEGORY |
| function getobjectCategory |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
objectCategory
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEOBJECTCATEGORY |
| function updateobjectCategory |
Arguments:
| Name |
Required |
Type |
Default |
| objectCategoryOBJ |
Required |
objectCategory |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| objectsdao |
| [cfc66] component
components.objects.objectsDAO
|
| METHODS |
| CREATEOBJECTS |
| function createObjects |
Arguments:
| Name |
Required |
Type |
Default |
| objectsOBJ |
Required |
objects |
|
|
| ReturnType: |
objects
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEOBJECTS |
| function deleteObjects |
Arguments:
| Name |
Required |
Type |
Default |
| ObjectsOBJ |
Required |
Objects |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETOBJECTS |
| function getObjects |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
Objects
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEOBJECTS |
| function updateObjects |
Arguments:
| Name |
Required |
Type |
Default |
| ObjectsOBJ |
Required |
Objects |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| objectsservice |
| [cfc67] component
components.objects.objectsService
|
| METHODS |
| CREATENEWGALLERYIMAGE |
| function createNewGalleryImage |
Arguments:
| Name |
Required |
Type |
Default |
| gallerySubCategoryKey |
Required |
numeric |
|
| clientKey |
Required |
numeric |
|
| userKey |
Required |
numeric |
|
| uploadDiskPath |
Required |
string |
|
| uploadURLPath |
Required |
string |
|
| thumbnailDiskPath |
Required |
string |
|
| thumbnailURLPath |
Required |
string |
|
| originalFileName |
Required |
string |
|
| FileExt |
Required |
string |
|
| FileSize |
Required |
string |
|
| largeFileName |
Required |
string |
|
| thumbnailFileName |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEALLGALLERYIMAGES |
| function deleteAllGalleryImages |
Arguments:
| Name |
Required |
Type |
Default |
| galleryKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEGALLERYIMAGE |
| function deleteGalleryImage |
Arguments:
| Name |
Required |
Type |
Default |
| galleryImageKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEGALLERYIMAGEENTRY |
| function deleteGalleryImageEntry |
Arguments:
| Name |
Required |
Type |
Default |
| galleryImageKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETALLDIRECTORYFILESFROMDIRECTORYANDPATH |
| function getAllDirectoryFilesFromDirectoryAndPath |
Arguments:
| Name |
Required |
Type |
Default |
| path |
Required |
string |
|
| directory |
Required |
string |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETALLFILESFROMPATH |
| function getAllFilesFromPath |
Arguments:
| Name |
Required |
Type |
Default |
| completeFilePath |
Required |
string |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETALLOBJECTS |
| function getAllObjects |
Arguments:
| Name |
Required |
Type |
Default |
| categoryKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETALLOBJECTSBYCATEGORYKEY |
| function getAllObjectsByCategoryKey |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETALLSUBDIRECTORIESFROMPATH |
| function getAllSubDirectoriesFromPath |
Arguments:
| Name |
Required |
Type |
Default |
| completeFilePath |
Required |
string |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCATEGORY |
| function getCategory |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETFILENAMESINJSON |
| function getFileNamesInJSON |
Arguments:
| Name |
Required |
Type |
Default |
| rootFileFolder |
Required |
string |
|
| secondaryFolder |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETFOLDERSINJSON |
| function getFoldersInJSON |
Arguments:
| Name |
Required |
Type |
Default |
| storageVolumePath |
Required |
string |
|
| storageFolder |
Required |
string |
|
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETGALLERIES |
| function getGalleries |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| galleryTypeKey |
Required |
numeric |
|
| galleryKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETGALLERIESINXML |
| function getGalleriesInXML |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| galleryTypeKey |
Required |
numeric |
|
| galleryKey |
Required |
numeric |
|
|
| ReturnType: |
xml
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETGALLERIESWITHPRIMARYIMAGE |
| function getGalleriesWithPrimaryImage |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| galleryTypeKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETGALLERYIMAGES |
| function getGalleryImages |
Arguments:
| Name |
Required |
Type |
Default |
| galleryKey |
Required |
numeric |
|
| numberToReturn |
Required |
numeric |
|
| excludePrimary |
Optional |
boolean |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETGALLERYKEYS |
| function getGalleryKeys |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| galleryTypeKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETOBJECTBYKEY |
| function getObjectByKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| objectKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETOBJECTSBYCATEGORYKEYINJSON |
| function getObjectsByCategoryKeyInJSON |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
| subCategoryKey |
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: |
|
|
|
| GETOBJECTSUBCATEGORIESINJSON |
| function getObjectSubCategoriesInJSON |
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: |
|
|
|
| GETRESOURCESBYCATEGORYKEY |
| function getResourcesByCategoryKey |
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: |
|
|
|
| GETRESOURCESBYSUBCATEGORYKEY |
| function getResourcesBySubCategoryKey |
Arguments:
| Name |
Required |
Type |
Default |
| subCategoryKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETRESOURCESFORDOWNLOADING_JSON_PAGINATED |
| function getResourcesForDownloading_JSON_Paginated |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
| subCategoryKey |
Required |
string |
|
| rowStart |
Required |
numeric |
|
| returnNumberOfRows |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETROOTDIRECTORIESFROMPATH |
| function getRootDirectoriesFromPath |
Arguments:
| Name |
Required |
Type |
Default |
| path |
Required |
string |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETSECONDARYCATEGORIESINJSON |
| function getSecondaryCategoriesInJSON |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
| subCategoryKey |
Required |
numeric |
|
| activeOnlyBit |
Optional |
boolean |
|
| withResourcesOnlyBit |
Optional |
boolean |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETSUBCATEGORY |
| function getSubCategory |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| subCategoryKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETTESTIMONIALCATEGORIES |
| function getTestimonialCategories |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| activeOnlyBit |
Optional |
boolean |
|
| withResourcesOnlyBit |
Optional |
boolean |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETTESTIMONIALS |
| function getTestimonials |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| subCategoryKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTPRIMARYCATEGORYDROPDOWN |
| function insertPrimaryCategoryDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| defaultValue |
Required |
numeric |
|
| class |
Optional |
string |
|
| disabled |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTRESOURCEFILTERDROPDOWN |
| function insertResourceFilterDropDown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| clientKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
| activeOnlyBit |
Optional |
boolean |
|
| withResourcesOnlyBit |
Optional |
boolean |
|
| defaultValue |
Required |
numeric |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTROOTFOLDERDROPDOWN |
| function insertRootFolderDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| defaultValue |
Required |
string |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTSTORAGEVOLUMEDROPDOWN |
| function insertStorageVolumeDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| defaultValue |
Required |
string |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| MAINTAINFILEMANAGERFILE |
| function maintainFileManagerFile |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| filePathString |
Required |
string |
|
| modifiedDate |
Required |
string |
|
| fileName |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| NEWOBJECTINSERTROUTINE |
| function newObjectInsertRoutine |
Arguments:
| Name |
Required |
Type |
Default |
| categoryKey |
Required |
numeric |
|
| secondaryCategoryKey |
Required |
numeric |
|
| userKey |
Required |
numeric |
|
| fileLocationPath |
Required |
string |
|
| clientFile |
Required |
string |
|
| clientServerDirectory |
Required |
string |
|
| clientServerFile |
Required |
string |
|
| fileContentSubType |
Required |
string |
|
| fileFilesize |
Required |
string |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SETGALLERYIMAGESORTORDER |
| function setGalleryImageSortOrder |
Arguments:
| Name |
Required |
Type |
Default |
| galleryImageKeyList |
Required |
string |
|
| galleryKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SETGALLERYPRIMARYIMAGE |
| function setGalleryPrimaryImage |
Arguments:
| Name |
Required |
Type |
Default |
| galleryImageKey |
Required |
numeric |
|
| galleryKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SUBCATEGORYMAINTENANCE |
| function subCategoryMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
| subCategoryKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| secondaryCategoryName |
Required |
string |
|
| secondaryCategoryDescription |
Required |
string |
|
| secondaryCategorySortOrder |
Required |
numeric |
|
| secondaryCategoryIsActiveBit |
Required |
boolean |
|
| secondaryCategoryPageTitle |
Required |
string |
|
| secondaryCategoryFolderName |
Required |
string |
|
| secondaryCategoryMultipleUploadsBit |
Required |
boolean |
|
| secondaryCategoryDeleteRequest |
Required |
boolean |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATERESOURCEACTIVESTATUS |
| function updateResourceActiveStatus |
Arguments:
| Name |
Required |
Type |
Default |
| action |
Required |
boolean |
|
| objectKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATERESOURCESORTORDER |
| function updateResourceSortOrder |
Arguments:
| Name |
Required |
Type |
Default |
| newPosition |
Required |
numeric |
|
| objectKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| primaryCategoryKey |
Required |
numeric |
|
| secondaryCategoryKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| objecttypeicondiskpath |
E:\WEB\mightecontent.com.v3\assets\custom\img\objectTypeIcons\
|
| objecttypeiconurlpath |
/assets/custom/img/objectTypeIcons/
|
| orderloggingonbit |
1
|
| orderpaymentloggingonbit |
1
|
| pagearticlesdao |
| [cfc68] component
components.pages.pageArticlesDAO
|
| METHODS |
| CREATEPAGEARTICLES |
| function createPageArticles |
Arguments:
| Name |
Required |
Type |
Default |
| PageArticlesOBJ |
Required |
PageArticles |
|
|
| ReturnType: |
PageArticles
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEPAGEARTICLES |
| function deletePageArticles |
Arguments:
| Name |
Required |
Type |
Default |
| PageArticlesOBJ |
Required |
PageArticles |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGEARTICLES |
| function getPageArticles |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
PageArticles
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEPAGEARTICLES |
| function updatePageArticles |
Arguments:
| Name |
Required |
Type |
Default |
| PageArticlesOBJ |
Required |
PageArticles |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| pagelayoutsdao |
| [cfc69] component
components.pages.pageLayoutsDAO
|
| METHODS |
| CREATEPAGELAYOUT |
| function createPageLayout |
Arguments:
| Name |
Required |
Type |
Default |
| PageLayoutOBJ |
Required |
PageLayout |
|
|
| ReturnType: |
PageLayout
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEPAGELAYOUT |
| function deletePageLayout |
Arguments:
| Name |
Required |
Type |
Default |
| PageLayoutOBJ |
Required |
PageLayout |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGELAYOUT |
| function getPageLayout |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
PageLayout
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEPAGELAYOUT |
| function updatePageLayout |
Arguments:
| Name |
Required |
Type |
Default |
| PageLayoutOBJ |
Required |
PageLayout |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| pagesdao |
| [cfc70] component
components.pages.pagesDAO
|
| METHODS |
| CREATEPAGES |
| function createPages |
Arguments:
| Name |
Required |
Type |
Default |
| PagesOBJ |
Required |
Pages |
|
|
| ReturnType: |
Pages
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEPAGES |
| function deletePages |
Arguments:
| Name |
Required |
Type |
Default |
| PagesOBJ |
Required |
Pages |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGES |
| function getPages |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
Pages
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEPAGES |
| function updatePages |
Arguments:
| Name |
Required |
Type |
Default |
| PagesOBJ |
Required |
Pages |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| pageservice |
| [cfc71] component
components.pages.pageService
|
| METHODS |
| COPYPAGE |
| function copyPage |
Arguments:
| Name |
Required |
Type |
Default |
| pageKey |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATECUSTOMCONTENTIMAGE |
| function createCustomContentImage |
Arguments:
| Name |
Required |
Type |
Default |
| customContentKey |
Required |
numeric |
|
| customerKey |
Required |
numeric |
|
| largeFileName |
Required |
string |
|
| thumbnailFileName |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGEARTICLECONTENT |
| function getPageArticleContent |
Arguments:
| Name |
Required |
Type |
Default |
| pageArticleKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGEARTICLESLIST |
| function getPageArticlesList |
Arguments:
| Name |
Required |
Type |
Default |
| pageKey |
Required |
numeric |
|
| pageArticleKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGEAUDITHISTORY |
| function getPageAuditHistory |
Arguments:
| Name |
Required |
Type |
Default |
| pageKey |
Required |
numeric |
|
| pageArticleKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| totalRecords |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGEBYFILENAME |
| function getPageByFileName |
Arguments:
| Name |
Required |
Type |
Default |
| fileName |
Required |
string |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGEBYPAGEKEY |
| function getPageByPageKey |
Arguments:
| Name |
Required |
Type |
Default |
| pageKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGEBYPATH |
| function getPageByPath |
Arguments:
| Name |
Required |
Type |
Default |
| pageURLPath |
Required |
string |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGECONTENTBYCLIENTINJSON |
| function getPageContentByClientInJSON |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| pageKey |
Required |
numeric |
|
| activeOnly |
Required |
boolean |
|
| 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: |
|
|
|
| GETPAGECONTENTDETAILS |
| function getPageContentDetails |
Arguments:
| Name |
Required |
Type |
Default |
| pageContentKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGEDETAILS |
| function getPageDetails |
Arguments:
| Name |
Required |
Type |
Default |
| pageKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGESBYCLIENTINJSON |
| function getPagesByClientInJSON |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| activeOnly |
Required |
boolean |
|
| 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: |
|
|
|
| GETPAGESIDEBARANDASSIGNEDCONTENT |
| function getPageSidebarAndAssignedContent |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| pageSidebarKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGESIDEBARCONTENTBYCLIENTINJSON |
| function getPageSidebarContentByClientInJSON |
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: |
|
|
|
| GETPAGESIDEBARCONTENTBYCONTENTKEY |
| function getPageSidebarContentByContentKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| pageSidebarContentKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGESIDEBARCONTENTFORDISPLAY |
| function getPageSideBarContentForDisplay |
Arguments:
| Name |
Required |
Type |
Default |
| pageKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGESIDEBARDETAILS |
| function getPageSidebarDetails |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| pageSidebarKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGESIDEBARFORDISPLAY |
| function getPageSideBarForDisplay |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| pageKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGESIDEBARFORPREVIEW |
| function getPageSideBarForPreview |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| sidebarKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGESIDEBARSBYCLIENTINJSON |
| function getPageSidebarsByClientInJSON |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| activeOnly |
Required |
boolean |
|
| 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: |
|
|
|
| GETPAGESINGLEARTICLEKEY |
| function getPageSingleArticleKey |
Arguments:
| Name |
Required |
Type |
Default |
| pageKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTPAGEHISTORYUNDODROPDOWN |
| function insertPageHistoryUndoDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| pageKey |
Required |
numeric |
|
| pageArticleKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| totalRecords |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a dropdown |
| Description: |
|
|
|
| INSERTPAGESIDEBARCODEBLOCKS |
| function insertPageSidebarCodeBlocks |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a dropdown |
| Description: |
|
|
|
| INSERTPAGESIDEBARCONTENTCHOICESMULTISELECT |
| function insertPageSidebarContentChoicesMultiSelect |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| pageSidebarKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a slushbox html |
| Description: |
|
|
|
| INSERTPAGESIDEBARCONTENTMULTISELECT |
| function insertPageSidebarContentMultiSelect |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| pageSidebarContentKey |
Required |
numeric |
|
| pageSidebarKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a slushbox html |
| Description: |
|
|
|
| INSERTPAGESIDEBARMULTISELECT |
| function insertPageSidebarMultiSelect |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| pageSidebarKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a slushbox html |
| Description: |
|
|
|
| INSERTPAGETYPEDROPDOWN |
| function insertPageTypeDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
| defaultValue |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a Yes/No Dropdown field into the HTML page |
| Description: |
|
|
|
| MAINTAINSIDEBARCONTENTHASH |
| function maintainSidebarContentHash |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| pageSidebarKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| sidebarContentKeyLIST |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| MAINTAINSIDEBARCONTENTHASHWITHSIDEBARKEY |
| function maintainSidebarContentHashWithSidebarKey |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| pageSidebarKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| sidebarContentKeyLIST |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| MAINTAINSIDEBARPAGEHASH |
| function maintainSidebarPageHash |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| pageSidebarKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| pageKeyLIST |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| PAGEARTICLEMAINTENANCE |
| function pageArticleMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| pageKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| REMOVECUSTOMCONTENTIMAGE |
| function removeCustomContentImage |
Arguments:
| Name |
Required |
Type |
Default |
| customContentKey |
Required |
numeric |
|
| customerKey |
Required |
numeric |
|
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| REMOVEPAGESIDEBARFROMHASH |
| function removePageSidebarFromHash |
Arguments:
| Name |
Required |
Type |
Default |
| pageSidebarKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| REMOVESIDEBARCONTENTFROMHASH |
| function removeSidebarContentFromHash |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| pageSidebarKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| RESIZECOVERIMAGEDIMENSIONS |
| function resizeCoverImageDimensions |
Arguments:
| Name |
Required |
Type |
Default |
| imageSrc |
Required |
string |
|
| fileExt |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UNDOPAGEARTICLETOPAGEHISTORYKEY |
| function undoPageArticleToPageHistoryKey |
Arguments:
| Name |
Required |
Type |
Default |
| pageArticleHistoryKey |
Required |
numeric |
|
| pageArticleKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEARTICLEACTIVESTATUS |
| function updateArticleActiveStatus |
Arguments:
| Name |
Required |
Type |
Default |
| action |
Required |
boolean |
|
| articleKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| pageKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEARTICLESORTORDER |
| function updateArticleSortOrder |
Arguments:
| Name |
Required |
Type |
Default |
| newPosition |
Required |
numeric |
|
| articleKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| pageKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEPAGEARTICLE |
| function updatePageArticle |
Arguments:
| Name |
Required |
Type |
Default |
| pageArticleKey |
Required |
numeric |
|
| pageArticleHTML |
Required |
string |
|
| pageArticleMainCSS |
Required |
string |
|
| pageArticleSectionCSS |
Required |
string |
|
| sessionUserKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| pagesidebarcontentdao |
| [cfc72] component
components.pages.pageSidebarContentDAO
|
| METHODS |
| CREATEPAGESIDEBARCONTENT |
| function createPageSidebarContent |
Arguments:
| Name |
Required |
Type |
Default |
| PageSidebarContentOBJ |
Required |
PageSidebarContent |
|
|
| ReturnType: |
PageSidebarContent
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEPAGESIDEBARCONTENT |
| function deletePageSidebarContent |
Arguments:
| Name |
Required |
Type |
Default |
| PageSidebarContentOBJ |
Required |
PageSidebarContent |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGESIDEBARCONTENT |
| function getPageSidebarContent |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
PageSidebarContent
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEPAGESIDEBARCONTENT |
| function updatePageSidebarContent |
Arguments:
| Name |
Required |
Type |
Default |
| PageSidebarContentOBJ |
Required |
PageSidebarContent |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| pagesidebarsdao |
| [cfc73] component
components.pages.pageSidebarsDAO
|
| METHODS |
| CREATEPAGESIDEBARS |
| function createPageSidebars |
Arguments:
| Name |
Required |
Type |
Default |
| PageSidebarsOBJ |
Required |
PageSidebars |
|
|
| ReturnType: |
PageSidebars
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEPAGESIDEBARS |
| function deletePageSidebars |
Arguments:
| Name |
Required |
Type |
Default |
| PageSidebarsOBJ |
Required |
PageSidebars |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGESIDEBARS |
| function getPageSidebars |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
PageSidebars
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEPAGESIDEBARS |
| function updatePageSidebars |
Arguments:
| Name |
Required |
Type |
Default |
| PageSidebarsOBJ |
Required |
PageSidebars |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| pagetypesdao |
| [cfc74] component
components.pages.pageTypesDAO
|
| METHODS |
| CREATEPAGETYPES |
| function createPageTypes |
Arguments:
| Name |
Required |
Type |
Default |
| PageTypesOBJ |
Required |
PageTypes |
|
|
| ReturnType: |
PageTypes
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEPAGETYPES |
| function deletePageTypes |
Arguments:
| Name |
Required |
Type |
Default |
| PageTypesOBJ |
Required |
PageTypes |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPAGETYPES |
| function getPageTypes |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
PageTypes
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEPAGETYPES |
| function updatePageTypes |
Arguments:
| Name |
Required |
Type |
Default |
| PageTypesOBJ |
Required |
PageTypes |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| pagevisitloggingonbit |
1
|
| passwordloggingonbit |
1
|
| patternsdirectory |
E:\WEB\shared-assets\resources\patterns\
|
| paymentprocessingislivebit |
1
|
| pdfdiskpath |
E:\WEB\mightecontent.com.v3\downloads\pdf\2\
|
| pdfurlpath |
/downloads/pdf/2/
|
| placeholderimageurlpath |
https://beta.mightecontent.com/assets/custom/img/gallery/
|
| placeholderthumbnailurlpath |
https://beta.mightecontent.com/assets/custom/img/galleryThumbs/
|
| poimaplattitude |
46.6555218
|
| poimaplongitude |
-96.4187618
|
| pointsofinterestdao |
| [cfc75] component
components.pointsOfInterest.PointsOfInterestDAO
|
| METHODS |
| CREATEPOINTSOFINTEREST |
| function createPointsOfInterest |
Arguments:
| Name |
Required |
Type |
Default |
| PointsOfInterestOBJ |
Required |
PointsOfInterest |
|
|
| ReturnType: |
PointsOfInterest
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEPOINTSOFINTEREST |
| function deletePointsOfInterest |
Arguments:
| Name |
Required |
Type |
Default |
| PointsOfInterestOBJ |
Required |
PointsOfInterest |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPOINTSOFINTEREST |
| function getPointsOfInterest |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
PointsOfInterest
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEPOINTSOFINTEREST |
| function updatePointsOfInterest |
Arguments:
| Name |
Required |
Type |
Default |
| PointsOfInterestOBJ |
Required |
PointsOfInterest |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| pointsofinterestservice |
| [cfc76] component
components.pointsOfInterest.PointsOfInterestService
|
| METHODS |
| GETPOINTOFINTERESTICONS |
| function getPointOfInterestIcons |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPOINTSOFINTEREST |
| function getPointsOfInterest |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| poiTypeKey |
Required |
numeric |
|
| pageKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPOINTSOFINTERESTXML |
| function getPointsOfInterestXML |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| poiTypeKey |
Required |
numeric |
|
| pageKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPOISBYCLIENTINJSON |
| function getPOIsByClientInJSON |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| poiTypeKey |
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: |
|
|
|
| GETPOITYPESSBYCLIENTINJSON |
| function getPOITypessByClientInJSON |
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: |
|
|
|
| INSERTPOIFILTERDROPDOWN |
| function insertPOIFilterDropDown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| clientKey |
Required |
numeric |
|
| poiTypeKey |
Required |
numeric |
|
| class |
Optional |
string |
|
| hideShowAll |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTPOINTOFINTERESTICONSDROPDOWN |
| function insertPointOfInterestIconsDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| clientKey |
Required |
numeric |
|
| defaultValue |
Required |
numeric |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| pointsofinteresttypesdao |
| [cfc77] component
components.pointsOfInterest.PointsOfInterestTypesDAO
|
| METHODS |
| CREATEPOINTSOFINTERESTTYPES |
| function createPointsOfInterestTypes |
Arguments:
| Name |
Required |
Type |
Default |
| PointsOfInterestTypesOBJ |
Required |
PointsOfInterestTypes |
|
|
| ReturnType: |
PointsOfInterestTypes
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEPOINTSOFINTERESTTYPES |
| function deletePointsOfInterestTypes |
Arguments:
| Name |
Required |
Type |
Default |
| PointsOfInterestTypesOBJ |
Required |
PointsOfInterestTypes |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETPOINTSOFINTERESTTYPES |
| function getPointsOfInterestTypes |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
PointsOfInterestTypes
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEPOINTSOFINTERESTTYPES |
| function updatePointsOfInterestTypes |
Arguments:
| Name |
Required |
Type |
Default |
| PointsOfInterestTypesOBJ |
Required |
PointsOfInterestTypes |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| remoteservice |
| [cfc78] component
components.remoteService.remoteService
|
| METHODS |
| ARCHIVETHISNEWSLETTER |
| function archiveThisNewsletter |
Arguments:
| Name |
Required |
Type |
Default |
| userKey |
Required |
numeric |
|
| newsletterDescription |
Required |
string |
|
| newsletterSubject |
Required |
string |
|
| newsletterBody |
Required |
string |
|
| remoteServiceKey |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| remoteservicekey |
be4ac9f7-295b-4a17-9d90-b84f80035bd7
|
| reportstoragediskpath |
E:\WEB\mightecontent.com.v3\assets\custom\img\2\
|
| reportstorageurlpath |
/assets/custom/img/2/
|
| resourcediskpath |
E:\WEB\mightecontent.com.v3\downloads\resources\2\
|
| resourceurlpath |
/downloads/resources/2/
|
| resumeservice |
| [cfc79] component
components.resumes.resumeService
|
| METHODS |
| DELETERESUME |
| function deleteResume |
Arguments:
| Name |
Required |
Type |
Default |
| resumeKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Delete a resume |
| Description: |
|
|
|
| GETALLACTIVERESUMES |
| function getAllActiveResumes |
| Arguments: | none |
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETALLRESUMES |
| function getAllResumes |
| Arguments: | none |
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETAPPLICANTFILEUPLOADSTATUS |
| function getApplicantFileUploadStatus |
Arguments:
| Name |
Required |
Type |
Default |
| resumeKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETRESUME |
| function getResume |
Arguments:
| Name |
Required |
Type |
Default |
| resumeKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETRESUMEOBJECTS |
| function getResumeObjects |
Arguments:
| Name |
Required |
Type |
Default |
| resumeKey |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTRESUMEAPPLICANTCONTACTPREFERENCES |
| function insertResumeApplicantContactPreferences |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| defaultValue |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a dropdown |
| Description: |
|
|
|
| INSERTRESUMEJOBCATEGORIES |
| function insertResumeJobCategories |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| categoryKeyLIST |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
Inserts a dropdown |
| Description: |
|
|
|
| MAINTAINRESUME |
| function maintainResume |
Arguments:
| Name |
Required |
Type |
Default |
| resumeKey |
Required |
numeric |
|
| resumeTitle |
Required |
string |
|
| resumeFirstName |
Required |
string |
|
| resumeLastName |
Required |
string |
|
| resumeAddress |
Required |
string |
|
| resumeAddress2 |
Required |
string |
|
| resumeCity |
Required |
string |
|
| resumeStateProvinceRegion |
Required |
string |
|
| resumeZip |
Required |
string |
|
| resumePhoneNumber |
Required |
string |
|
| resumeEmail |
Required |
string |
|
| resumeContents |
Required |
string |
|
| resumeJobCategoryList |
Required |
string |
|
| resumeOkayToContactFK |
Required |
numeric |
|
| resumeActiveBit |
Required |
boolean |
|
| resumeHasAttachmentsBit |
Required |
boolean |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPLOADAPPLICANTFILEVIAMODAL |
| function uploadApplicantFileViaModal |
Arguments:
| Name |
Required |
Type |
Default |
| qqfile |
Required |
string |
|
| clientKey |
Required |
numeric |
|
| resumeKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| sessionloggingonbit |
1
|
| sessionmanager |
| [cfc80] component
components.sessionManagement.sessionManager
|
| METHODS |
| ADMAINTENANCE |
| function adMaintenance |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| APPLICATIONSESSIONMAINTENANCE |
| function applicationSessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clearStruct |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| BLOCKDISPLAYSESSIONMAINTENANCE |
| function blockDisplaySessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| categoryKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CLIENTADS |
| function clientAds |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CLIENTAPPEARANCESESSIONMAINTENANCE |
| function clientAppearanceSessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CLIENTAPPMAILSETTINGSSESSIONMAINTENANCE |
| function clientAppMailSettingsSessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CLIENTSESSIONMAINTENANCE |
| function clientSessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATEAPPLICATIONSESSION |
| function createApplicationSession |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DESTROYAPPSTRUCT |
| function destroyAppSTRUCT |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
Destroy Session variables for the entire app. |
| Description: |
|
|
|
| GETLOCALMAILSERVERVARIABLES |
| function getLocalMailServerVariables |
| Arguments: | none |
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| MAINTAINCLIENTAPPLICATIONFEATURES |
| function maintainClientApplicationFeatures |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| MAINTAINDROPDOWNSELECTION |
| function maintainDropdownSelection |
Arguments:
| Name |
Required |
Type |
Default |
| dropdownPage |
Required |
string |
|
| dropdownKey |
Required |
numeric |
|
| dropdownString |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| MAINTAINDYNAMICNAVIGATION |
| function maintainDynamicNavigation |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| PAGEARTICLESESSIONMAINTENANCE |
| function pageArticleSessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| pageArticleKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| PAGESESSIONMAINTENANCE |
| function pageSessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| pageKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SELECTEDCATEGORYSESSIONMAINTENANCE |
| function selectedCategorySessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| categoryKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SELECTEDCLIENTAD |
| function SelectedClientAd |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| adKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SELECTEDCLIENTAPPEARANCESESSIONMAINTENANCE |
| function selectedClientAppearanceSessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SELECTEDCLIENTAPPLICATIONFEATURES |
| function selectedClientApplicationFeatures |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SELECTEDCLIENTSESSIONMAINTENANCE |
| function selectedClientSessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SELECTEDDOCUMENTATIONNAVIGTIONSESSIONMAINTENANCE |
| function selectedDocumentationNavigtionSessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| documentationKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SELECTEDDOCUMENTATIONSESSIONMAINTENANCE |
| function selectedDocumentationSessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| documentationKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SELECTEDDOCUMENTCHAPTERSESSIONMAINTENANCE |
| function selectedDocumentChapterSessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| documentationKey |
Required |
numeric |
|
| documentChapterKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SELECTEDDOCUMENTSECTIONSESSIONMAINTENANCE |
| function selectedDocumentSectionSessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| sessionUserKey |
Required |
numeric |
|
| documentationKey |
Required |
numeric |
|
| documentChapterKey |
Required |
numeric |
|
| documentSectionKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SELECTEDJOBLISTINGSESSIONMAINTENANCE |
| function selectedJobListingSessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| jobListingKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SELECTEDNEWSARTICLESESSIONMAINTENANCE |
| function selectedNewsArticleSessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| newsArticleKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SELECTEDPAGESIDEBARCONTENTSESSIONMAINTENANCE |
| function selectedPageSidebarContentSessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| sidebarContentKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SELECTEDPAGESIDEBARSESSIONMAINTENANCE |
| function selectedPageSidebarSessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| sidebarKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SELECTEDPOPUPCONTENTSESSIONMAINTENANCE |
| function SelectedPopupContentSessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| popupKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SELECTEDRESOURCECATEGORYSESSIONMAINTENANCE |
| function selectedResourceCategorySessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| resourceCategoryKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SELECTEDRESOURCESESSIONMAINTENANCE |
| function selectedResourceSessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| resourceKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SELECTEDRESOURCESUBCATEGORYSESSIONMAINTENANCE |
| function selectedResourceSubCategorySessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| resourceSubCategoryKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SELECTEDRESUMEMAINTENANCE |
| function SelectedResumeMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| resumeKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SELECTEDSUBCATEGORYSESSIONMAINTENANCE |
| function selectedSubCategorySessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| subCategoryKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SELECTEDUSERSESSIONMAINTENANCE |
| function selectedUserSessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| userKey |
Required |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SETLOGINUSERSESSIONVARIABLES |
| function setLoginUserSessionVariables |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
| validationMessage |
Required |
numeric |
|
| userSessionTracker |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEALLCLIENTSESSIONVARIABLES |
| function updateAllClientSessionVariables |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Optional |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEALLSELECTEDCLIENTSESSIONVARIABLES |
| function updateAllSelectedClientSessionVariables |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Optional |
numeric |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATESESSIONLOGGEDINSTATUS |
| function updateSessionLoggedInStatus |
Arguments:
| Name |
Required |
Type |
Default |
| loggedInSTRUCT |
Optional |
struct |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| USERSESSIONMAINTENANCE |
| function userSessionMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
| validationMessage |
Required |
numeric |
|
| userSessionTracker |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| USERSESSIONTRACKERMAINTENANCE |
| function userSessionTrackerMaintenance |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Optional |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| sessionoutputison |
0
|
| sharedcalendarfunctions |
| [cfc81] component
components.calendars.sharedCalendarFunctions
|
| METHODS |
| INSERTCALENDARCATEGORIESDROPDOWN |
| function insertCalendarCategoriesDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCALENDARCATEGORYFILTERDROPDOWN |
| function insertCalendarCategoryFilterDropDown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| clientKey |
Required |
numeric |
|
| calendarCategoryKey |
Required |
numeric |
|
| class |
Optional |
string |
|
| hideShowAll |
Optional |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCALENDARRECURRINGSCHEDULEDROPDOWN |
| function insertCalendarRecurringScheduleDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCALENDARSTATUSDROPDOWN |
| function insertCalendarStatusDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCALENDARTYPEDROPDOWN |
| function insertCalendarTypeDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCALENDARTYPEDROPDOWNWITHONCHANGE |
| function insertCalendarTypeDropdownWithOnChange |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTCOLORDROPDOWN |
| function insertColorDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTDEDUCTIONNUMBERLISTDROPDOWN |
| function insertDeductionNumberListDropDown |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTRECURRINGDAYDROPDOWN |
| function insertRecurringDayDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| clientKey |
Required |
numeric |
|
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTRECURRINGDAYRADIOBUTTONS |
| function insertRecurringDayRadioButtons |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| defaultValue |
Required |
numeric |
|
| class |
Optional |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTRECURRINGFREQUENCYDROPDOWN |
| function insertRecurringFrequencyDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INSERTRECURRINGINTERVALDROPDOWN |
| function insertRecurringIntervalDropdown |
Arguments:
| Name |
Required |
Type |
Default |
| fieldname |
Required |
string |
|
| class |
Optional |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
true |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| shareddocumentsassignmentsdiskpath |
E:\WEB\shared-assets\documents\shared\files\assignments\2\
|
| shareddocumentsassignmentsurlpath |
/shared-assets/documents/shared/files/assignments/2/
|
| shareddocumentsdiskpath |
E:\WEB\shared-assets\documents\shared\files\2\
|
| shareddocumentspublicdiskpath |
E:\WEB\shared-assets\documents\shared\public-files\2\
|
| shareddocumentspublicurlpath |
/shared-assets/documents/shared/public-files/2/
|
| shareddocumentsurlpath |
/shared-assets/documents/shared/files/2/
|
| sharedfilesclientkey |
2
|
| stategateway |
| [cfc82] component
components.commonFunctions.stateGateway
|
| METHODS |
| GETCOUNTRYNAME |
| function getCountryName |
Arguments:
| Name |
Required |
Type |
Default |
| countryKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETSTATENAME |
| function getStateName |
Arguments:
| Name |
Required |
Type |
Default |
| stateKey |
Required |
numeric |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETSTATES |
| function getStates |
| Arguments: | none |
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Retrieve all State information. Returns a query |
| Description: |
|
|
|
|
|
| subcategoriesdao |
| [cfc83] component
components.categories.subCategoriesDAO
|
| METHODS |
| CREATESUBCATEGORIES |
| function createSubCategories |
Arguments:
| Name |
Required |
Type |
Default |
| subCategoriesOBJ |
Required |
subCategories |
|
|
| ReturnType: |
subCategories
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETESUBCATEGORIES |
| function deletesubCategories |
Arguments:
| Name |
Required |
Type |
Default |
| subCategoriesOBJ |
Required |
subCategories |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETSUBCATEGORIES |
| function getsubCategories |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
subCategories
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATESUBCATEGORIES |
| function updatesubCategories |
Arguments:
| Name |
Required |
Type |
Default |
| subCategoriesOBJ |
Required |
subCategories |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| supercompanyname |
MightESolutions
|
| systemauditingison |
1
|
| systememailnotificationsareon |
1
|
| timezone |
EST
|
| timezoneid |
15
|
| useractivityloggingison |
1
|
| utilities |
| [cfc84] component
components.commonFunctions.utilities
|
| METHODS |
| AUDITLOGENTRY |
| function auditLogEntry |
Arguments:
| Name |
Required |
Type |
Default |
| customerKey |
Required |
numeric |
|
| orderKey |
Required |
numeric |
|
| sessionTracker |
Required |
string |
|
| localVariables |
Required |
string |
|
| activityDescription |
Required |
string |
|
| activityDetail |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CHECKFORREMOTEFILEEXISTENCE |
| function checkForRemoteFileExistence |
Arguments:
| Name |
Required |
Type |
Default |
| fileName |
Required |
string |
|
| urlPath |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CLEANHIGHASCII |
| function CleanHighAscii |
Arguments:
| Name |
Required |
Type |
Default |
| Text |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Cleans extended ascii values to make the as web safe as possible. |
| Description: |
|
|
|
| CONTACTFORMEMAILANDSPAMCHECK |
| function contactFormEmailAndSpamCheck |
Arguments:
| Name |
Required |
Type |
Default |
| emailAddress |
Required |
string |
|
| submittedFirstName |
Required |
string |
|
| submittedLastName |
Required |
string |
|
| submittedComments |
Required |
string |
|
| submittersIPAddress |
Required |
string |
|
| submittersProtocol |
Required |
string |
|
| submittersRequestMethod |
Required |
string |
|
| submittedPhoneNumber |
Required |
string |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| CREATESPAMLOGCONTENT |
| function createSpamLogContent |
Arguments:
| Name |
Required |
Type |
Default |
| emailAddress |
Required |
string |
|
| submittedName |
Required |
string |
|
| submittedComments |
Required |
string |
|
| submittersIPAddress |
Required |
string |
|
| submittersProtocol |
Required |
string |
|
| submittersRequestMethod |
Required |
string |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| EMAILADDRESSLISTBYORDERKEY |
| function emailAddressListByOrderKey |
Arguments:
| Name |
Required |
Type |
Default |
| orderKey |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ESCAPEEXTENDEDCHARS |
| function EscapeExtendedChars |
Arguments:
| Name |
Required |
Type |
Default |
| str |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| FORMSUBMISSIONSPAMCHECK |
| function formSubmissionSpamCheck |
Arguments:
| Name |
Required |
Type |
Default |
| emailAddress |
Required |
string |
|
| submittedFirstName |
Required |
string |
|
| submittedLastName |
Required |
string |
|
| submittedCompanyName |
Required |
string |
|
| submittedCity |
Required |
string |
|
| submittedState |
Required |
string |
|
| submittedZip |
Required |
string |
|
| submittedPhoneNumber |
Required |
string |
|
| submittedComments |
Required |
string |
|
| submittersIPAddress |
Required |
string |
|
| submittersProtocol |
Required |
string |
|
| submittersRequestMethod |
Required |
string |
|
|
| ReturnType: |
numeric
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GENERATEICALFILE |
| function generateICalFile |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETCONTENTBOXCONFIGINXML |
| function getContentBoxConfigInXML |
| Arguments: | none |
| ReturnType: |
xml
|
| Roles: |
|
| Access: |
remote |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETFILESIZE |
| function getFileSize |
Arguments:
| Name |
Required |
Type |
Default |
| filepath |
Required |
string |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETLATTITUDELONGITUDEBYADDRESS |
| function getLattitudeLongitudeByAddress |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETLATTITUDELONGITUDEBYEVENTADDRESS |
| function getLattitudeLongitudeByEventAddress |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETLATTITUDELONGITUDEBYPOIMAPADDRESS |
| function getLattitudeLongitudeByPOIMapAddress |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETLATTITUDELONGITUDEBYPOINTOFINTERESTADDRESS |
| function getLattitudeLongitudeByPointOfInterestAddress |
Arguments:
| Name |
Required |
Type |
Default |
| poiKey |
Required |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETNOHRCSPEAKERDETAIL |
| function getNOHRCSpeakerDetail |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETNOHRCSPEAKERLIST |
| function getNOHRCSpeakerList |
| Arguments: | none |
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETRANDOMVALUE |
| function getRandomValue |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETVALIDFILEEXTENSIONLIST |
| function getValidFileExtensionLIST |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETWEBPATH |
| function getWebPath |
Arguments:
| Name |
Required |
Type |
Default |
| url |
Optional |
Any |
[runtime expression] |
| ext |
Optional |
Any |
\.(cfml?.*|html?.*|[^.]+) |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Gets the absolute path to the current web folder. |
| Description: |
|
|
|
| ICALUS |
| function iCalUS |
Arguments:
| Name |
Required |
Type |
Default |
| stEvent |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ISCFC |
| function IsCFC |
Arguments:
| Name |
Required |
Type |
Default |
| objectToCheck |
Required |
any |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ISEXTENTIONIMAGE |
| function isExtentionImage |
Arguments:
| Name |
Required |
Type |
Default |
| fileExtention |
Required |
string |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| ISOTODATETIME |
| function ISOToDateTime |
Arguments:
| Name |
Required |
Type |
Default |
| Date |
Required |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Converts an ISO 8601 date/time stamp with optional dashes to a ColdFusion date/time stamp. |
| Description: |
|
|
|
| LOCALURL |
| function localUrl |
Arguments:
| Name |
Required |
Type |
Default |
| file |
Optional |
Any |
|
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
|
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| LOGACTIVITYBYCLIENT |
| function logActivityByClient |
Arguments:
| Name |
Required |
Type |
Default |
| logText |
Required |
string |
|
| logType |
Optional |
numeric |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| LOGLARGEACTIVITYBYCLIENT |
| function logLargeActivityByClient |
Arguments:
| Name |
Required |
Type |
Default |
| logText |
Required |
string |
|
| logType |
Required |
numeric |
|
| additionalDetails |
Optional |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| LOGTOCUSTOM |
| function logToCustom |
Arguments:
| Name |
Required |
Type |
Default |
| logText |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SCRUBSTRINGTOSAFECHARACTERS |
| function scrubStringToSafeCharacters |
Arguments:
| Name |
Required |
Type |
Default |
| stringValue |
Optional |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
This will return |
| Description: |
|
|
|
| SCRUBSTRINGTOSAFECHARACTERSNOSPACES |
| function scrubStringToSafeCharactersNoSpaces |
Arguments:
| Name |
Required |
Type |
Default |
| stringValue |
Optional |
string |
|
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
This will return |
| Description: |
|
|
|
| SYSTEMEMAILNOTIFICATION |
| function systemEmailNotification |
Arguments:
| Name |
Required |
Type |
Default |
| auditDescription |
Required |
string |
|
| auditContent |
Required |
string |
|
| emailSubject |
Required |
string |
|
| emailContent |
Required |
string |
|
| customerKey |
Required |
numeric |
|
| subjectDescription |
Required |
string |
|
| subjectKey |
Required |
numeric |
|
| emailSentTo |
Required |
string |
|
| emailSentFrom |
Required |
string |
|
| emailSentToCC |
Required |
string |
|
| emailSentToBC |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| TAGSTRIPPER |
| function tagStripper |
Arguments:
| Name |
Required |
Type |
Default |
| source |
Required |
string |
|
| action |
Optional |
string |
strip |
| tagList |
Optional |
string |
[empty string] |
|
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| VALIDATEEMAILADDRESS |
| function validateEmailAddress |
Arguments:
| Name |
Required |
Type |
Default |
| emailAddresses |
Required |
string |
|
|
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
no |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| websitecontactsdao |
| [cfc85] component
components.websiteContacts.websiteContactsDAO
|
| METHODS |
| CREATEWEBSITECONTACTS |
| function createWebsiteContacts |
Arguments:
| Name |
Required |
Type |
Default |
| websiteContactsOBJ |
Required |
websiteContacts |
|
|
| ReturnType: |
websiteContacts
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| DELETEWEBSITECONTACTS |
| function deletewebsiteContacts |
Arguments:
| Name |
Required |
Type |
Default |
| websiteContactsOBJ |
Required |
websiteContacts |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETWEBSITECONTACTS |
| function getwebsiteContacts |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
websiteContacts
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| UPDATEWEBSITECONTACTS |
| function updatewebsiteContacts |
Arguments:
| Name |
Required |
Type |
Default |
| websiteContactsOBJ |
Required |
websiteContacts |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|
| websitecontactsservice |
| [cfc86] component
components.websiteContacts.websiteContactsService
|
| METHODS |
| GETALLWEBSITECONTACTS |
| function getAllwebsiteContacts |
| Arguments: | none |
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETWEBSITECONTACTSBYKEY |
| function getwebsiteContactsByKey |
Arguments:
| Name |
Required |
Type |
Default |
| key |
Required |
numeric |
|
|
| ReturnType: |
query
|
| Roles: |
|
| Access: |
public |
| Static: |
false |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
|
|