Class Schedule

Schedule service

Example

 const list = await cam.schedule.getScheduleInfoList();
 const token = list.scheduleInfo![0].token;
 console.log((await cam.schedule.getScheduleState({ token })).active);

Hierarchy (View Summary)

default
- Schedule

Constructors

constructor

new Schedule(onvif: Onvif): Schedule
Parameters
- onvif: Onvif
Returns Schedule
Overrides default.constructor
- Defined in schedule.ts:57

Properties

`Protected` `Readonly`onvif

onvif: Onvif

`Protected` `Readonly`service

service: keyof OnvifServices

`Protected` `Readonly`xmlns

xmlns: string

Methods

createSchedule

createSchedule(options: CreateSchedule): Promise<string>
Creates a new schedule.
Parameters
- options: CreateSchedule
Returns Promise<string>
- Defined in schedule.ts:190

createSpecialDayGroup

createSpecialDayGroup(options: CreateSpecialDayGroup): Promise<string>
Creates a new special day group.
Parameters
- options: CreateSpecialDayGroup
Returns Promise<string>
- Defined in schedule.ts:280

deleteSchedule

deleteSchedule(options: DeleteSchedule): Promise<void>
Deletes a schedule.
Parameters
- options: DeleteSchedule
Returns Promise<void>
- Defined in schedule.ts:215

deleteSpecialDayGroup

deleteSpecialDayGroup(options: DeleteSpecialDayGroup): Promise<void>
Deletes a special day group.
Parameters
- options: DeleteSpecialDayGroup
Returns Promise<void>
- Defined in schedule.ts:311

getScheduleInfo

getScheduleInfo(options: GetScheduleInfo): Promise<GetScheduleInfoResponse>
Returns schedule info items for the requested tokens.
Parameters
- options: GetScheduleInfo
Returns Promise<GetScheduleInfoResponse>
- Defined in schedule.ts:135

getScheduleInfoList

getScheduleInfoList(
options?: GetScheduleInfoList,
): Promise<GetScheduleInfoListResponse>
Returns a list of schedule info items.
Parameters
- options: GetScheduleInfoList = {}
Returns Promise<GetScheduleInfoListResponse>
- Defined in schedule.ts:144

getScheduleList

getScheduleList(options?: GetScheduleList): Promise<GetScheduleListResponse>
Returns a list of schedule items.
Parameters
- options: GetScheduleList = {}
Returns Promise<GetScheduleListResponse>
- Defined in schedule.ts:173

getSchedules

getSchedules(options: GetSchedules): Promise<GetSchedulesResponse>
Returns schedule items for the requested tokens.
Parameters
- options: GetSchedules
Returns Promise<GetSchedulesResponse>
- Defined in schedule.ts:161

getScheduleState

getScheduleState(options: GetScheduleState): Promise<ScheduleState>
Returns the current state of a schedule.
Parameters
- options: GetScheduleState
Returns Promise<ScheduleState>
- Defined in schedule.ts:126

getServiceCapabilities

getServiceCapabilities(): Promise<Capabilities>
Returns the capabilities of the schedule service.

Returns Promise<Capabilities>
- Defined in schedule.ts:117

getSpecialDayGroupInfo

getSpecialDayGroupInfo(
options: GetSpecialDayGroupInfo,
): Promise<GetSpecialDayGroupInfoResponse>
Returns special day group info items for the requested tokens.
Parameters
- options: GetSpecialDayGroupInfo
Returns Promise<GetSpecialDayGroupInfoResponse>
- Defined in schedule.ts:223

getSpecialDayGroupInfoList

getSpecialDayGroupInfoList(
options?: GetSpecialDayGroupInfoList,
): Promise<GetSpecialDayGroupInfoListResponse>
Returns a list of special day group info items.
Parameters
- options: GetSpecialDayGroupInfoList = {}
Returns Promise<GetSpecialDayGroupInfoListResponse>
- Defined in schedule.ts:235

getSpecialDayGroupList

getSpecialDayGroupList(
options?: GetSpecialDayGroupList,
): Promise<GetSpecialDayGroupListResponse>
Returns a list of special day group items.
Parameters
- options: GetSpecialDayGroupList = {}
Returns Promise<GetSpecialDayGroupListResponse>
- Defined in schedule.ts:263

getSpecialDayGroups

getSpecialDayGroups(
options: GetSpecialDayGroups,
): Promise<GetSpecialDayGroupsResponse>
Returns special day group items for the requested tokens.
Parameters
- options: GetSpecialDayGroups
Returns Promise<GetSpecialDayGroupsResponse>
- Defined in schedule.ts:254

modifySchedule

modifySchedule(options: ModifySchedule): Promise<void>
Modifies an existing schedule.
Parameters
- options: ModifySchedule
Returns Promise<void>
- Defined in schedule.ts:207

modifySpecialDayGroup

modifySpecialDayGroup(options: ModifySpecialDayGroup): Promise<void>
Modifies an existing special day group.
Parameters
- options: ModifySpecialDayGroup
Returns Promise<void>
- Defined in schedule.ts:301

request

request<T = any>(
body: Record<string, any>,
options?: LineraseOptions,
): Promise<T>
Type Parameters
- T = any
Parameters
- body: Record<string, any>
- Optionaloptions: LineraseOptions
Returns Promise<T>
Inherited from default.request
- Defined in service.ts:49

setSchedule

setSchedule(options: SetSchedule): Promise<void>
Creates or replaces a schedule (requires ClientSuppliedTokenSupported).
Parameters
- options: SetSchedule
Returns Promise<void>
- Defined in schedule.ts:199

setSpecialDayGroup

setSpecialDayGroup(options: SetSpecialDayGroup): Promise<void>
Creates or replaces a special day group (requires ClientSuppliedTokenSupported).
Parameters
- options: SetSpecialDayGroup
Returns Promise<void>
- Defined in schedule.ts:293

Class Schedule

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Schedule

Properties

Protected Readonlyonvif

Protected Readonlyservice

Protected Readonlyxmlns

Methods

createSchedule

Parameters

Returns Promise<string>

createSpecialDayGroup

Parameters

Returns Promise<string>

deleteSchedule

Parameters

Returns Promise<void>

deleteSpecialDayGroup

Parameters

Returns Promise<void>

getScheduleInfo

Parameters

Returns Promise<GetScheduleInfoResponse>

getScheduleInfoList

Parameters

Returns Promise<GetScheduleInfoListResponse>

getScheduleList

Parameters

Returns Promise<GetScheduleListResponse>

getSchedules

Parameters

Returns Promise<GetSchedulesResponse>

getScheduleState

Parameters

Returns Promise<ScheduleState>

getServiceCapabilities

Returns Promise<Capabilities>

getSpecialDayGroupInfo

Parameters

Returns Promise<GetSpecialDayGroupInfoResponse>

getSpecialDayGroupInfoList

Parameters

Returns Promise<GetSpecialDayGroupInfoListResponse>

getSpecialDayGroupList

Parameters

Returns Promise<GetSpecialDayGroupListResponse>

getSpecialDayGroups

Parameters

Returns Promise<GetSpecialDayGroupsResponse>

modifySchedule

Parameters

Returns Promise<void>

modifySpecialDayGroup

Parameters

Returns Promise<void>

request

Type Parameters

Parameters

Returns Promise<T>

setSchedule

Parameters

Returns Promise<void>

setSpecialDayGroup

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`onvif

`Protected` `Readonly`service

`Protected` `Readonly`xmlns