Options
All
  • Public
  • Public/Protected
  • All
Menu

Category contains the APIs for category operations.

Index

Functions

  • 创建频道分组。

    仅社区所有者可以调用该方法。

    connection.createCategory({serverId: 'serverId', name: "name"})
    

    Parameters

    • this: Connection
    • params: { name: string; serverId: string }
      • name: string

        频道分组名称。

      • serverId: string

        社区 ID。

    Returns Promise<AsyncResult<CategoryInfo>>

  • deleteCategory(this: Connection, params: { categoryId: string; serverId: string }): Promise<void>
  • 删除频道分组。

    仅社区所有者可调用该方法。

    connection.deleteCategory({serverId: 'serverId', categoryId: 'categoryId'})
    

    Parameters

    • this: Connection
    • params: { categoryId: string; serverId: string }
      • categoryId: string

        频道分组 ID。

      • serverId: string

        社区 ID。

    Returns Promise<void>

  • 分页获取当前分组下的私密频道列表。

    SDK 按私密频道的创建时间正序查询。

    connection.getCategoryPrivateChannels({serverId: 'serverId', categoryId: "categoryId",pagesize:20,cursor:''})
    

    Parameters

    • this: Connection
    • params: { categoryId: string; cursor?: string; pageSize?: number; serverId: string }
      • categoryId: string

        频道分组 ID。

      • Optional cursor?: string

        开始获取数据的游标位置。首次调用方法时传空字符串,SDK 从最早创建的频道开始获取。

      • Optional pageSize?: number

        每页期望获取的频道数量。取值范围为 [1,20],默认值为 20

      • serverId: string

        社区 ID。

    Returns Promise<AsyncResult<ChannelInfoListResult>>

  • 分页获取当前分组下的公开频道列表。

    SDK 按公开频道的创建时间正序查询。

    connection.getCategoryPublicChannels({serverId: 'serverId', categoryId: "categoryId",pagesize:20,cursor:''})
    

    Parameters

    • this: Connection
    • params: { categoryId: string; cursor?: string; pageSize?: number; serverId: string }
      • categoryId: string

        频道分组 ID。

      • Optional cursor?: string

        开始获取数据的游标位置。首次调用方法时传空字符串,SDK 从最早创建的频道开始获取。

      • Optional pageSize?: number

        每页期望获取的频道数量。取值范围为 [1,20],默认值为 20

      • serverId: string

        社区 ID。

    Returns Promise<AsyncResult<ChannelInfoListResult>>

  • 获取频道分组列表。

    connection.getCategorylist({serverId: 'serverId',pageSize:20,cursor:''})
    

    Parameters

    • this: Connection
    • params: { cursor?: string; pageSize?: number; serverId: string }
      • Optional cursor?: string

        开始获取数据的游标位置。首次调用方法时传空字符串,SDK 从最早创建的频道分组开始获取。

      • Optional pageSize?: number

        每页期望获取的频道分组数量。取值范围为 [1,20],默认值为 20

      • serverId: string

        社区 ID。

    Returns Promise<AsyncResult<CategoryInfoListResult>>

  • transferChannel(this: Connection, params: { channelId: string; newCategoryId?: string; serverId: string }): Promise<void>
  • 将频道移动至其他分组。

    仅社区所有者和管理员可以调用该方法。

    connection.transferChannel({serverId: 'serverId',channelId:'channelId', newCategoryId: 'newCategoryId'})
    

    Parameters

    • this: Connection
    • params: { channelId: string; newCategoryId?: string; serverId: string }
      • channelId: string

        要转移分组的频道的 ID。

      • Optional newCategoryId?: string

        目标频道分组的 ID。

        如果不传,默认将频道转移到到社区的默认频道分组中。

      • serverId: string

        社区 ID。

    Returns Promise<void>

  • 修改频道分组名称。

    仅社区所有者和管理员可调用该方法。

    connection.updateCategory({serverId: 'serverId',categoryId: 'categoryId', name: "name"})
    

    Parameters

    • this: Connection
    • params: { categoryId: string; name: string; serverId: string }
      • categoryId: string

        频道分组 ID。

      • name: string

        修改后的频道分组名称。

      • serverId: string

        社区 ID。

    Returns Promise<AsyncResult<CategoryInfo>>

Generated using TypeDoc