Internal Console API

InternalGroupManager

Other API in Package

Console

Console System

Console Webservice

List of Classes

InternalConsoleController

AjaxResponse

AnalyticDataViewFilter

Archive

ArchiveManager

AreaChart

Attachment

AudioFile

BarChart

BillingEngine

BillingEvent

Browser

Buffer

BusinessUtil

CacheManager

Cell

CellFilter

Chart

ChartSharedSettings

ChartTool

Chunk

CommonPacket

ConsoleManager

ConsolePacket

ConsoleResponse

Cube

Data

DataList

DataListFilter

DataReader

DataRecord

DataSet

DataSetRecord

DataSetResult

DataView

DataViewBuilder

DataViewCriteria

DataViewFilter

DataViewList

DataViewRecord

DatasetFile

DateUtil

DisplaySettings

Document

DocumentFile

DownloadResponse

Email

EncryptionUtil

Enterprise

EnterpriseInfo

ExcelFile

File

FileBuffer

Formatter

Fragment

FtpRequest

GeoUtil

GroupConcat

ImageFile

Inspector

Installer

InstallerPal

InternalAcmeService

InternalApiMonitor

InternalAuthManager

InternalCloud

InternalCloudDomain

InternalCloudSubscriptionManager

InternalCloudSubscriptionService

InternalDesktopProduct

InternalDevelopmentPal

InternalDomainManager

InternalEmail

InternalEmailManager

InternalEmailSettings

InternalEnterprise

InternalGroupManager

InternalKey

InternalKeyFeatures

InternalKeyManager

InternalKeyPricing

InternalLogoManager

InternalPalChain

InternalPalInfo

InternalPalManager

InternalPalStore

InternalPalStoreInfo

InternalPalStoreInvite

InternalPalStoreItem

InternalProfile

InternalProfileManager

InternalPseudoKey

InternalRequest

InternalResponse

InternalSecuritySettings

InternalStatBuilder

InternalStatement

InternalStorageManager

InternalStorageProvider

InternalSupportIncident

InternalSupportProfile

InternalSystemInformation

InternalSystemLog

InternalSystemManager

InternalTunnelManager

InternalUser

InternalWebAlias

InternalZone

InternalZoneManager

JSONBuffer

JSONParser

Job

JobManager

LineChart

LockManager

Logger

MailBox

MailBoxList

MailMessage

MailResponse

Message

MessageManager

MobileManager

Modules

Monitor

PWA

Packet

PacketDataList

PacketDataRecord

Page

PagingInfo

Pal

PalActivationKeyInfo

PalInfo

Payload

PdfFile

PieChart

Profile

ProfileInfo

ProfilePacket

ProfilePalManager

ProfileTxManager

QRUtil

Render

Request

Role

RuntimePal

SSOToken

SafeBox

ScatterPlotChart

ServiceRequest

ServiceResponse

ShellPal

ShellPalManager

SignSettings

SiteBuilder

Slice

SmartDoc

SmartDocManager

Socket

SocketResponse

StorageProvider

StorageProviderDataList

StoredObject

SystemDataView

SystemDataViewFilter

Tag

TagFilter

TagManager

TextEmail

TextMessage

TiffBuilder

TransactionPacket

TransactionUtil

Tunnel

TunnelResult

UnknownFile

Upload

User

VCardFile

Validator

ValidityCheck

Wizard

WorkflowResponse

XMLReader

ZoneAccess

Method Summary
boolean addProfile(String name, String profileId)

Adds the profile to the group with default permissions inherited. See updateProfile.
  createGroup(String name, String description, Data settings)

Creates a group.
boolean deleteGroup(String name)

Deletes the group.
Data getGroupSettings(String name)

Returns the settings for the group.
SystemDataView getGroups()

Returns a view for accessing groups.
SystemDataView getPalGroups(String name)

Returns a view for accessing pal groups.
SystemDataView getProfileGroups(String name)

Returns a view for accessing profile groups.
Data getProfileSettings(String name, String profileId)

Returns the specified profile settings.
boolean hasGroup(String name)

Returns true if the group exists.
boolean isActive(String name)

Returns true if the group is active.
  removeProfile(String name, String profileId)

Removes the profile from the group.
  setActive(String name, boolean active)

Sets the active status of the group.
  setGroupSettings(String name, Data settings)

Sets the settings for the group.
String toString()

Returns a description of this object.
boolean updateProfile(String name, String profileId, Data settings)

Updates the profile settings for the group.

Method Detail

boolean addProfile(String name, String profileId)

Adds the profile to the group with default permissions inherited. See updateProfile.

Parameters:

  • String   name Required parameter. Maximum allowed size of parameter: 255
  • String   profileId Required parameter.

Returns:  boolean

Since: 11-05-2020

top
createGroup(String name, String description, Data settings)

Creates a group.

Parameters:

  • String   name Required parameter. Maximum allowed size of parameter: 255
  • String   description Maximum allowed size of parameter: 255
  • Data   settings Required parameter.

Since: 11-05-2020

top
boolean deleteGroup(String name)

Deletes the group.

Parameters:

  • String   name Required parameter. Maximum allowed size of parameter: 255

Returns:  boolean

Since: 11-05-2020

top
Data getGroupSettings(String name)

Returns the settings for the group.

Parameters:

  • String   name Required parameter. Maximum allowed size of parameter: 255

Returns:  Data

Since: 11-05-2020

top
SystemDataView getGroups()

Returns a view for accessing groups.

Returns:  SystemDataView


DataList Name: Groups
Tag Support: No
DataList Keys/Column Name Column Type Read Only
name String  
description String  
createDate Date  
active Boolean  

Since: 11-05-2020

top
SystemDataView getPalGroups(String name)

Returns a view for accessing pal groups.

Parameters:

  • String   name Required parameter. Maximum allowed size of parameter: 255

Returns:  SystemDataView


DataList Name: PalGroups
Tag Support: No
DataList Keys/Column Name Column Type Read Only
palId String  
name String  
description String  
createDate Date  

Since: 11-05-2020

top
SystemDataView getProfileGroups(String name)

Returns a view for accessing profile groups.

Parameters:

  • String   name Required parameter. Maximum allowed size of parameter: 255

Returns:  SystemDataView


DataList Name: ProfileGroups
Tag Support: No
DataList Keys/Column Name Column Type Read Only
profileId String  
firstName String  
lastName String  
email String  

Since: 11-05-2020

top
Data getProfileSettings(String name, String profileId)

Returns the specified profile settings.

Parameters:

  • String   name Required parameter. Maximum allowed size of parameter: 255
  • String   profileId Required parameter.

Returns:  Data

Since: 11-05-2020

top
boolean hasGroup(String name)

Returns true if the group exists.

Parameters:

  • String   name Required parameter. Maximum allowed size of parameter: 255

Returns:  boolean

Since: 11-05-2020

top
boolean isActive(String name)

Returns true if the group is active.

Parameters:

  • String   name Required parameter. Maximum allowed size of parameter: 255

Returns:  boolean

Since: 11-05-2020

top
removeProfile(String name, String profileId)

Removes the profile from the group.

Parameters:

  • String   name Required parameter. Maximum allowed size of parameter: 255
  • String   profileId Required parameter.

Since: 11-05-2020

top
setActive(String name, boolean active)

Sets the active status of the group.

Parameters:

  • String   name Required parameter. Maximum allowed size of parameter: 255
  • boolean   active Required parameter.

Since: 11-05-2020

top
setGroupSettings(String name, Data settings)

Sets the settings for the group.

Parameters:

  • String   name Required parameter. Maximum allowed size of parameter: 255
  • Data   settings Required parameter.

Since: 11-05-2020

top
String toString()

Returns a description of this object.

Returns:  String

Since: 11-05-2020

top
boolean updateProfile(String name, String profileId, Data settings)

Updates the profile settings for the group.

Parameters:

  • String   name Required parameter. Maximum allowed size of parameter: 255
  • String   profileId Required parameter.
  • Data   settings Required parameter.

Returns:  boolean

Since: 11-05-2020

top
Copyright © 2006 - 2024, ContractPal, Inc. All rights reserved. API Date: May 01, 2024 05:15 AM