ts-onvif/build/interfaces/accessrules.d.ts

Client to ONVIF NVT devices

import { ReferenceToken } from './common';
import { DataEntity } from './types';
import { Name, Description } from './onvif';
/**
 * The service capabilities reflect optional functionality of a service. The information is static
 * and does not change during device operation. The following capabilities are available:
 */
export interface ServiceCapabilities {
    /**
     * The maximum number of entries returned by a single Get<Entity>List or Get<Entity>
     * request. The device shall never return more than this number of entities in a single
     * response.
     */
    maxLimit: unknown;
    /** Indicates the maximum number of access profiles supported by the device. */
    maxAccessProfiles: unknown;
    /** Indicates the maximum number of access policies per access profile supported by the device. */
    maxAccessPoliciesPerAccessProfile: unknown;
    /**
     * Indicates whether or not several access policies can refer to the same access point in an
     * access profile.
     */
    multipleSchedulesPerAccessPointSupported: boolean;
    /**
     * Indicates that the client is allowed to supply the token when creating access profiles. To
     * enable the use of the command SetAccessProfile, the value must be set to true.
     */
    clientSuppliedTokenSupported?: boolean;
    [key: string]: unknown;
}
/**
 * The access policy is an association of an access point and a schedule. It defines when an access
 * point can be accessed using an access profile which contains this access policy. If an access
 * profile contains several access policies specifying different schedules for the same access
 * point will result in a union of the schedules.
 */
export interface AccessPolicy {
    /** Reference to the schedule used by the access policy. */
    scheduleToken: ReferenceToken;
    /**
     * Reference to the entity used by the rule engine, the entity type may be specified by the
     * optional EntityType field explained below but is typically an access point.
     */
    entity: ReferenceToken;
    /**
     * Optional entity type; if missing, an access point type as defined by the ONVIF Access
     * Control Service Specification should be assumed. This can also be represented by the
     * QName value	“tac:AccessPoint” where tac is the namespace of ONVIF Access Control
     * Service Specification. This field is provided for future extensions; it will allow an
     * access policy being	extended to cover entity types other than access points as well.
     */
    entityType?: unknown;
    extension?: AccessPolicyExtension;
}
export interface AccessPolicyExtension {
    [key: string]: unknown;
}
/**
 * The AccessProfileInfo structure contains basic information about an access profile. The device
 * shall provide the following fields for each access profile instance.
 */
export interface AccessProfileInfo extends DataEntity {
    /** A user readable name. It shall be up to 64 characters. */
    name: Name;
    /**
     * User readable description for the access profile. It shall be up
     * to 1024 characters.
     */
    description?: Description;
}
/**
 * The access profile structure contains information about the collection of access policies. The
 * device shall include all properties of the AccessProfileInfo structure and also a list of access
 * policies.
 */
export interface AccessProfile extends AccessProfileInfo {
    /**
     * A list of access policy structures, where each access policy
     * defines during which schedule an access point can be accessed.
     */
    accessPolicy?: AccessPolicy[];
    extension?: AccessProfileExtension;
}
export interface AccessProfileExtension {
    [key: string]: unknown;
}
export interface Capabilities extends ServiceCapabilities {
}
export interface GetServiceCapabilities {
}
export interface GetServiceCapabilitiesResponse {
    /**
     * The capability response message contains the requested access rules
     * service capabilities using a hierarchical XML capability structure.
     */
    capabilities: ServiceCapabilities;
}
export interface GetAccessProfileInfo {
    /** Tokens of AccessProfileInfo items to get. */
    token: ReferenceToken[];
}
export interface GetAccessProfileInfoResponse {
    /** List of AccessProfileInfo items. */
    accessProfileInfo?: AccessProfileInfo[];
}
export interface GetAccessProfileInfoList {
    /**
     * Maximum number of entries to return. If not specified, less than one
     * or higher than what the device supports, the number of items is determined by the
     * device.
     */
    limit?: number;
    /**
     * Start returning entries from this start reference. If not specified,
     * entries shall start from the beginning of the dataset.
     */
    startReference?: string;
}
export interface GetAccessProfileInfoListResponse {
    /**
     * StartReference to use in next call to get the following items. If
     * absent, no more items to get.
     */
    nextStartReference?: string;
    /** List of AccessProfileInfo items. */
    accessProfileInfo?: AccessProfileInfo[];
}
export interface GetAccessProfiles {
    /** Tokens of AccessProfile items to get. */
    token: ReferenceToken[];
}
export interface GetAccessProfilesResponse {
    /** List of Access Profile items. */
    accessProfile?: AccessProfile[];
}
export interface GetAccessProfileList {
    /**
     * Maximum number of entries to return. If not specified, less than one
     * or higher than what the device supports, the number of items is determined by the
     * device.
     */
    limit?: number;
    /**
     * Start returning entries from this start reference. If not specified,
     * entries shall start from the beginning of the dataset.
     */
    startReference?: string;
}
export interface GetAccessProfileListResponse {
    /**
     * StartReference to use in next call to get the following items. If
     * absent, no more items to get.
     */
    nextStartReference?: string;
    /** List of Access Profile items. */
    accessProfile?: AccessProfile[];
}
export interface CreateAccessProfile {
    /** The AccessProfile to create. */
    accessProfile: AccessProfile;
}
export interface CreateAccessProfileResponse {
    /** The Token of created AccessProfile. */
    token: ReferenceToken;
}
export interface ModifyAccessProfile {
    /** The details of Access Profile */
    accessProfile: AccessProfile;
}
export interface ModifyAccessProfileResponse {
}
export interface SetAccessProfile {
    /** The AccessProfile item to create or modify */
    accessProfile: AccessProfile;
}
export interface SetAccessProfileResponse {
}
export interface DeleteAccessProfile {
    /** The token of the access profile to delete. */
    token: ReferenceToken;
}
export interface DeleteAccessProfileResponse {
}