@espressif/rainmaker-base-cdf
    Preparing search index...

    Interface ESPCDFGroupOperation

    interface ESPCDFGroupOperation {
        addNodes(nodeIds: string[]): Promise<ESPCDFAPIResponse<any>>;
        convertToMatterFabric?(): Promise<ESPCDFGroup>;
        createAutomation?(
            automationData: ESPCDFAutomationCreateInput,
        ): Promise<any>;
        createScene?(sceneData: ESPCDFSceneCreateInput): Promise<any>;
        createSchedule?(scheduleData: ESPCDFScheduleCreateInput): Promise<any>;
        createSubGroup(data: Record<string, any>): Promise<ESPCDFGroup>;
        delete(): Promise<ESPCDFAPIResponse<any>>;
        getAutomations?(): Promise<ESPCDFPaginatedAPIResponse<ESPCDFAutomation[]>>;
        getFabricDetails?(): Promise<ESPCDFMatterFabricDetails>;
        getNodes(): Promise<ESPCDFNode[]>;
        getNodesWithDetails?(): Promise<ESPCDFNode[]>;
        getSceneCapableDevices?(group: ESPCDFGroup): Promise<any[]>;
        getScenes?(group: ESPCDFGroup): Promise<any[]>;
        getScheduleCapableDevices?(group: ESPCDFGroup): Promise<any[]>;
        getSchedules?(group: ESPCDFGroup): Promise<any[]>;
        getSharingInfo(
            options: Record<string, any>,
        ): Promise<ESPCDFAPIDataResponse<ESPCDFGroupSharingInfoInterface>>;
        getSubGroups(): Promise<ESPCDFGroup[]>;
        issueNodeNoC?(
            request: ESPCDFIssueNodeNoCRequest,
        ): Promise<ESPCDFMatterCommissioningRequest>;
        issueUserNoC?(): Promise<ESPCDFIssueUserNoCResponse>;
        leave(): Promise<ESPCDFAPIResponse<any>>;
        removeNodes(nodeIds: string[]): Promise<ESPCDFAPIResponse<any>>;
        removeSharingFor(username: string): Promise<ESPCDFAPIResponse<any>>;
        setParams?(
            payload: Record<string, Record<string, unknown>>,
        ): Promise<unknown>;
        share(params: Record<string, any>): Promise<string>;
        startCommissioning?(
            qrData: string,
            onProgress?: (message: ESPCDFCommissioningProgress) => void,
        ): Promise<() => void>;
        transfer(params: Record<string, any>): Promise<string>;
        updateGroupInfo(
            updates: Record<string, any>,
        ): Promise<ESPCDFAPIResponse<any>>;
        updateMetadata(
            metadata: Record<string, any>,
        ): Promise<ESPCDFAPIResponse<any>>;
    }
    Index

    Methods

    addNodes convertToMatterFabric? createAutomation? createScene? createSchedule? createSubGroup delete getAutomations? getFabricDetails? getNodes getNodesWithDetails? getSceneCapableDevices? getScenes? getScheduleCapableDevices? getSchedules? getSharingInfo getSubGroups issueNodeNoC? issueUserNoC? leave removeNodes removeSharingFor setParams? share startCommissioning? transfer updateGroupInfo updateMetadata

    Methods

    • Parameters

      • payload: Record<string, Record<string, unknown>>

      Returns Promise<unknown>

    • Parameters

      • params: Record<string, any>

      Returns Promise<string>

    • Parameters

      • params: Record<string, any>

      Returns Promise<string>

    Settings

    Member Visibility

    On This Page

    Methods