Configuration Platform SDK 8.5 API Reference
CfgScheduledTask
Description
A Scheduled Task is a GVP Object in which you schedule the GVP tasks
Top of Page
Filter Keys
Filter Name |
Type |
Description |
task_type |
int |
Type of the ScheduledTask (see CfgTaskType ).
If specified, Configuration Server will return information only
about the ScheduledTasks of this type.
|
state |
int |
Current state of a ScheduledTask (see CfgObjectState ).
If specified, Configuration Server will return information only
about ScheduledTasks that are currently in this state.
|
name |
string |
Name of a ScheduledTask. Shall be specified
as a character string. If specified, Configuration Server will return
information only about the ScheduledTask(s) with that name.
|
dbid |
int |
A unique identifier of a ScheduledTask. If
specified, Configuration Server will return information only about
this ScheduledTask.
|
Top of Page
Attributes
DBID
—
An identifier of this object in the Configuration Database.
Generated by Configuration Server and is unique within an object type.
Identifiers of deleted objects are not used again. Read-only.
name
—
A pointer to name of the ScheduledTask. Mandatory.
Must be unique within the Configuration Database.
type
—
Type of the ScheduledTask. Mandatory. Once
specified, cannot be changed. See type CfgTaskType
.
description
—
An optional short description of this ScheduledTask.
startTime
—
The time the task is to begin.
resources
—
A pointer to the list of the objects associated with this ScheduledTask
(every item of this list is structured as
CfgObjectResource
). When used as an entry
in CfgDeltaScheduledTask
, it is a pointer to a list of resources
added to the existing list.
Only objects of type CfgHost
,
CfgSwitch
,
CfgGVPCustomer
and
can be associated with ScheduledTask object through resources
state
—
Current object state. Mandatory. Refer to CfgObjectState
userProperties
—
A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair
of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary
list, that also has the TKVList structure and specifies the properties defined within that section.
Top of Page
Comments
Top of Page
See Also
CfgDeltaScheduledTask
Top of Page
Send comments on this topic.
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.