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

    Interface ESPCDFUserOperation

    interface ESPCDFUserOperation {
        addDevice?(
            user: ESPCDFUserInterface,
            params: AddDeviceParams,
            callbacks: GroupStoreCallbacks,
        ): Promise<ESPCDFNode | null>;
        addOnNetworkDevice?(
            user: ESPCDFUserInterface,
            params: AddOnNetworkDeviceParams,
            callbacks: GroupStoreCallbacks,
        ): Promise<ESPCDFNode | null>;
        assumeRole?(
            request: ESPCDFAssumeRoleRequest,
        ): Promise<ESPCDFAssumeRoleResponse>;
        changePassword(
            oldPassword: string,
            newPassword: string,
        ): Promise<ESPCDFAPIResponse<any>>;
        confirmAccountDeletion(code: string): Promise<ESPCDFAPIResponse<any>>;
        createFabric?(groupRequest: ESPCDFCreateGroupRequest): Promise<ESPCDFGroup>;
        createGroup(groupRequest: ESPCDFCreateGroupRequest): Promise<ESPCDFGroup>;
        createHome?(
            params: ESPCDFCreateHomeRequestParams,
            callbacks: GroupStoreCallbacks,
        ): Promise<ESPCDFGroup>;
        createProvisioningDevice(
            name: string,
            transport: string,
            security?: number,
            proofOfPossession?: string,
            softAPPassword?: string,
            username?: string,
        ): Promise<any>;
        getAccessToken(): Promise<string>;
        getCustomData(): Promise<any>;
        getGroupById(groupId: string, options: Record<string, any>): Promise<any>;
        getGroups(): Promise<ESPCDFPaginatedAPIResponse<ESPCDFGroup[]>>;
        getGroupsAndFabrics?(): Promise<ESPCDFGroup[]>;
        getIssuedGroupSharingRequests(
            count?: number,
        ): Promise<ESPCDFPaginatedAPIResponse<ESPCDFGroupSharingRequest[]>>;
        getNodeDetails(nodeId: string): Promise<ESPCDFNode>;
        getReceivedGroupSharingRequests(
            count?: number,
        ): Promise<ESPCDFPaginatedAPIResponse<ESPCDFGroupSharingRequest[]>>;
        getUserInfo(): Promise<ESPCDFAPIDataResponse<ESPCDFUserInfo>>;
        isUserNocAvailableForFabric?(fabricId: string): Promise<boolean>;
        logout(): Promise<void>;
        registerForNotification(
            platform: string,
            deviceToken: string,
        ): Promise<ESPCDFAPIDataResponse<any>>;
        requestAccountDeletion(): Promise<ESPCDFAPIResponse<any>>;
        searchESPBLEDevices(customerId: number): Promise<any[]>;
        searchESPDevices(prefix: string, transport: string): Promise<any[]>;
        setCurrentHome?(
            user: ESPCDFUserInterface,
            callbacks: GroupStoreCallbacks,
            home: ESPCDFGroup,
        ): Promise<void>;
        setCustomData(customData: ESPCDFUserCustomDataRequest): Promise<void>;
        setMultipleNodesParams(
            payload: { nodeId: string; payload: any }[],
        ): Promise<ESPCDFAPIResponse<any>>;
        setTimeZone(timeZone: string): Promise<ESPCDFAPIResponse<any>>;
        storePrecommissionInfo?(info: ESPCDFMatterPrecommissionInfo): Promise<void>;
        subscribeToEvent(
            event: string,
            callback: (data: any) => void,
        ): Promise<any>;
        subscribeToNodeUpdates?(
            params: ESPCDFSubscribeToNodeUpdatesRequestParams,
        ): Promise<void>;
        syncHomeWithNodes?(
            user: ESPCDFUserInterface,
            callbacks: GroupStoreCallbacks,
        ): Promise<ESPCDFGroup | null>;
        unregisterForNotification(
            deviceToken: string,
        ): Promise<ESPCDFAPIResponse<any>>;
        unsubscribeFromEvent(
            event: string,
            callback: (data: any) => void,
        ): Promise<any>;
        unsubscribeFromNodeUpdates?(): Promise<void>;
        updateName(name: string): Promise<ESPCDFAPIResponse<any>>;
        updateUserInfo(
            userInfo: Partial<ESPCDFUserInfo>,
        ): Promise<ESPCDFAPIResponse<any>>;
    }
    Index

    Methods

    addDevice? addOnNetworkDevice? assumeRole? changePassword confirmAccountDeletion createFabric? createGroup createHome? createProvisioningDevice getAccessToken getCustomData getGroupById getGroups getGroupsAndFabrics? getIssuedGroupSharingRequests getNodeDetails getReceivedGroupSharingRequests getUserInfo isUserNocAvailableForFabric? logout registerForNotification requestAccountDeletion searchESPBLEDevices searchESPDevices setCurrentHome? setCustomData setMultipleNodesParams setTimeZone storePrecommissionInfo? subscribeToEvent subscribeToNodeUpdates? syncHomeWithNodes? unregisterForNotification unsubscribeFromEvent unsubscribeFromNodeUpdates? updateName updateUserInfo

    Methods

    • Parameters

      • name: string
      • transport: string
      • Optionalsecurity: number
      • OptionalproofOfPossession: string
      • OptionalsoftAPPassword: string
      • Optionalusername: string

      Returns Promise<any>

    • Parameters

      • groupId: string
      • options: Record<string, any>

      Returns Promise<any>

    • Parameters

      • fabricId: string

      Returns Promise<boolean>

    • Parameters

      • prefix: string
      • transport: string

      Returns Promise<any[]>

    • Parameters

      • event: string
      • callback: (data: any) => void

      Returns Promise<any>

    • Parameters

      • event: string
      • callback: (data: any) => void

      Returns Promise<any>

    • Unsubscribe from node updates and release subscription manager resources.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Methods