사용자 금지/해제
사용자 금지
특정 사용자를 해당 그룹 채널에 참가하지 못 하도록 금지 할 수 있습니다.
주의
채널 매니저만 할 수 있습니다.
Parameter
속성 | 설명 | 유형 | 기본값 | 필수여부 |
---|---|---|---|---|
channelId | 채널 아이디 | String | 없음 | O |
userId | 사용자 아이디 | String | 없음 | O |
seconds | 금지 기간, 단위 초 | Number | 0 | X |
reason | 금지 이유 (4~200자) | String | 없음 | X |
- Swift
public func ban(channelId: String, userId: String, seconds: Int? = nil, reason: String? = nil, completion: ((BanInfo?, Int) -> ())? = nil)
// BanInfo: {
// "user": {
// "userId": "User ID",
// "name": "User Name",
// "created_at": 1669358202276,
// "updated_at": 1669358203107
// },
// "start_at": 1670916132911, // 금지 시작 일시
// "end_at": 1670916132911, // 금지 종료 일시
// "reason": "Reason"
// }
사용자 금지 해제
사용자 금지를 해제 할 수 있습니다.
주의
채널 매니저만 할 수 있습니다.
Parameter
속성 | 설명 | 유형 | 기본값 | 필수여부 |
---|---|---|---|---|
channelId | 채널 아이디 | String | 없음 | O |
userId | 사용자 아이디 | String | 없음 | O |
- Swift
public func unban(channelId: String, userId: String, completion: ((Bool, Int) -> ())? = nil)
사용자 금지 목록 조회
해당 채널의 사용자 금지 목록을 조회 할 수 있습니다.
조회 정렬 기준은 금지 시작일 내림차순입니다.
주의
채널 매니저만 할 수 있습니다.
Parameter
속성 | 설명 | 유형 | 기본값 | 필수여부 |
---|---|---|---|---|
channelId | 채널 아이디 | String | 없음 | O |
- Swift
public func getBannedList(channelId: String, completion: (([BanInfo]?, Int) -> ())? = nil)
// BanInfo: [
// {
// "user": {
// "userId": "User ID",
// "name": "User Name",
// "created_at": 1669358202276,
// "updated_at": 1669358203107
// },
// "start_at": 1670916132911, // 금지 시작 일시
// "end_at": 1670916132911, // 금지 종료 일시
// "reason": "Reason"
// }
// ...
//]