livelike logo
Product
NPM
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

Functions

blockProfile

  • description

    Block profile using profile Id

    async
    since

    2.13.0

    example
    blockProfile({profileId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7"}).then(blockInfo => console.log(blockInfo))

    Parameters

    Returns Promise<IBlockInfo>

getBlockInfoList

  • description

    Get Block Info list containing list of block info of all the blocked profile

    async
    since

    2.13.0

    example
    getBlockInfoList().then(paginatedBlockInfo => console.log(paginatedBlockInfo))

    Returns Promise<IPaginatedResponse<IBlockInfo>>

getBlockedProfileIds

  • description

    Get list of blocked profile ids, could be used to filter chat messages by blocked profile

    async
    since

    2.14.0

    example
    getBlockedProfileIds().then(profileIds => console.log(profileIds))

    Returns Promise<IPaginatedResponse<string>>

getProfileBlockInfo

  • description

    Get Block Info for given profile id if exists

    async
    since

    2.13.0

    example
    getProfileBlockInfo({profileId: "aa7e03fc-01f0-4a98-a2e0-3fed689632d7"}).then(blockInfo => console.log(blockInfo))

    Parameters

    Returns Promise<IBlockInfo | undefined>

unblockProfile

  • description

    Unblock profile using Block Info id for a given blocked profile, use getProfileBlockInfo or getBlockInfoList to get corresponding profile block info id

    async
    since

    2.13.0

    example
    unblockProfile({blockId: "c327a72c-94e5-4f5a-bcef-16ee84d35077"}).then(response => console.log(response))

    Parameters

    Returns Promise<any>

Legend

  • Function
  • Function with type parameter
  • Type alias
  • Type alias with type parameter
  • Interface
  • Interface with type parameter
  • Enumeration

Generated using TypeDoc