사용자 금지/해제

사용자 금지

특정 사용자를 해당 그룹 채널에 참가하지 못 하도록 금지 할 수 있습니다.

주의

채널 매니저만 할 수 있습니다.

Parameter

속성	설명	유형	기본값	필수여부
channel_id	채널 아이디	String	없음	O
user_id	사용자 아이디	String	없음	O
seconds	금지 기간, 단위 초	Number	0	X
reason	금지 이유 (4~200자)	String	없음	X

try {
  const channel_id = 'Group Channel ID';
  const params: GroupChannelBanParams {
    user_id: string;
    seconds: number;
    reason?: string;
  }
  const result = await gitpleLiveChatClient.groupChannel.ban(channel_id, params);
  // result: {
  //    "user": {
  //      "user_id": "User ID",
  //      "name": "User Name",
  //      "created_at": 1669358202276,
  //      "updated_at": 1669358203107
  //    },
  //    "start_at": 1670916132911,  // 금지 시작 일시
  //    "end_at": 1670916132911,  // 금지 종료 일시
  //    "reason": "Reason"
  //  }
} catch (error) {
  // handle error
}

사용자 금지 해제

사용자 금지를 해제 할 수 있습니다.

주의

채널 매니저만 할 수 있습니다.

Parameter

속성	설명	유형	기본값	필수여부
channel_id	채널 아이디	String	없음	O
user_id	사용자 아이디	String	없음	O

try {
  const channel_id = 'Group Channel ID';
  const user_id = 'User ID';
  await gitpleLiveChatClient.groupChannel.unban(channel_id, user_id);
} catch (error) {
  // handle error
}

사용자 금지 목록 조회

해당 채널의 사용자 금지 목록을 조회 할 수 있습니다.

조회 정렬 기준은 금지 시작일 내림차순입니다.

주의

채널 매니저만 할 수 있습니다.

Parameter

속성	설명	유형	기본값	필수여부
channel_id	채널 아이디	String	없음	O

try {
  const channel_id = 'Group Channel ID';
  const results = await gitpleLiveChatClient.groupChannel.getBannedList(channel_id);
  // results: [
  //  {
  //    "user": {
  //      "user_id": "User ID",
  //      "name": "User Name",
  //      "created_at": 1669358202276,
  //      "updated_at": 1669358203107
  //    },
  //    "start_at": 1670916132911,  // 금지 시작 일시
  //    "end_at": 1670916132911,  // 금지 종료 일시
  //    "reason": "Reason"
  //  }
  //  ...
  //]
} catch (error) {
  // handle error
}