생성/수정/삭제
그룹 채널 생성
정보
생성한 채널에는 자동 참가됩니다.
정보
1:1 채널을 만들 경우, reuse: true로 설정하여 요청을 보내면 기존에 동일한 참가자로 구성된 채널이 있다면 새로운 채널을 생성하지 않고 기존 채널 정보를 응답하기 때문에 대화를 이어갈 수 있습니다. 기존 채널이 없다면 새 채널이 생성됩니다.
기존 채널을 판단하는 기준은 채널 참가자가 동일하고, 해당 참가자들 외에 다른 참가자가 참가한 이력이 없으며, 매니저 등록 이력이 없는 경우입니다.
Parameters
속성 | 설명 | 유형 | 기본값 | 필수여부 |
---|---|---|---|---|
channelId | 채널 아이디. 소문자, 숫자, _ 만 사용할 수 있으며 4~80자로 제한됩니다. | String | 없음 | O |
name | 채널 이름. 1~150자로 제한됩니다. | String | 없음 | O |
profile | 프로필 URL. 최대 2,048자로 제한됩니다. | String | 없음 | X |
members | 참가시킬 사용자 아이디 목록. 최대 100명까지 참가 할 수 있습니다. | [String] | 없음 | O |
reuse | 기존 채널 사용 여부 | Boolean | false | O |
meta | 메타 데이터. key는 소/대문자, 한글, _, - 만 사용할 수 있으며 100byte string 으로 제한됩니다. value는 200byte string 으로 제합됩니다. key-value set은 최대 10개까지 저장할 수 있습니다. | Object | 없음 | X |
- Swift
public func createChannel( channelId: String,
name: String,
profile: String? = nil,
members: [String],
reuse: Bool = false,
meta: [String:String]? = nil,
completion: ((GroupChannel?, Int) -> ())? = nil)
그룹 채널 수정
주의
채널 매니저만 수정할 수 있습니다.
Parameters
속성 | 설명 | 유형 | 필수여부 |
---|---|---|---|
channelId | 채널 아이디 | String | O |
name | 채널 이름. 1~150자로 제한됩니다. | String | X |
profile | 프로필 URL. 최대 2,048자로 제한됩니다. | String | X |
- Swift
public func updateChannel(channelId: String, name: String, profile: String, completion: ((GroupChannel?, Int) -> ())? = nil)
그룹 채널 삭제
주의
채널 매니저만 삭제할 수 있습니다.
Parameters
속성 | 설명 | 유형 | 필수여부 |
---|---|---|---|
channelId | 채널 아이디 | String | O |
- Swift
public func deleteChannel(channelId: String, completion: ((Bool, Int) -> ())? = nil)