목록/정보
그룹 채널 목록 조회
그룹 채널 목록을 페이징 조회 할 수 있습니다. 조회 정렬 기준은 생성일 내림차순입니다.
다음 페이지가 있을 경우 응답 데이터에 'next' 정보가 전달됩니다. 응답에서 받은 'next' 값을 사용하여 다음 목록을 조회 할 수 있습니다. 다음 페이지 조회 시, 'next' 값만 전달하면 됩니다.
Parameters
속성 | 설명 | 유형 | 기본값 | 필수여부 |
---|---|---|---|---|
limit | 페이지 당 목록 수, 허용 범위 5 ~ 30 | Number | 15 | X |
showMembers | 채널 매니저 정보 포함 여부 | Boolean | false | X |
showManagers | 채널 참가자 정보 포함 여부 | Boolean | false | X |
showReadReceipt | 채널 읽기 영수증 정보 포함 여부 | Boolean | false | X |
showDeliveryReceipt | 채널 배달 영수증 정보 포함 여부 | Boolean | false | X |
showUnread | 사용자별 읽지않은 메시지 수 정보 포함 여부 | Boolean | false | X |
showLastMessage | 채널 마지막 메시지 정보 포함 여부 | Boolean | false | X |
name | 검색할 채널 이름(URL 인코딩 권장) | String | 없음 | X |
includeMembers | 참가자 검색 목록. 콤마(,)로 구분된 사용자 ID 문자열(공백 허용 안함)로 참가자들이 포함된 채널을 검색합니다. AND 조건입니다. (URL 인코딩 권장) | String | 없음 | X |
next | 다음 페이지 키 | String | 없음 | X |
- Swift
public func getChannelList( limit: Int = 15,
showMembers: Bool = true,
showManagers: Bool = true,
showReadReceipt: Bool = true,
showDeliveryReceipt: Bool = true,
showUnread: Bool = true,
showLastMessage: Bool = true,
name: String? = nil,
includeMembers: String? = nil,
next: String? = nil,
completion: ((ChannelPage?, Int) -> ())? = nil)
참가한 그룹 채널 목록 조회
사용자가 참가한 그룹 채널 목록을 페이징 조회 할 수 있습니다. 조회 정렬 기준은 생성일 내림차순입니다.
다음 페이지가 있을 경우 응답 데이터에 'next' 정보가 전달됩니다. 응답에서 받은 'next' 값을 사용하여 다음 목록을 조회 할 수 있습니다. 다음 페이지 조회 시, 'next' 값만 전달하면 됩니다.
Parameters
속성 | 설명 | 유형 | 기본값 | 필수여부 |
---|---|---|---|---|
limit | 페이지 당 목록 수, 허용 범위 5 ~ 30 | Number | 15 | X |
showMembers | 채널 매니저 정보 포함 여부 | Boolean | false | X |
showManagers | 채널 참가자 정보 포함 여부 | Boolean | false | X |
showReadReceipt | 채널 읽기 영수증 정보 포함 여부 | Boolean | false | X |
showDeliveryReceipt | 채널 배달 영수증 정보 포함 여부 | Boolean | false | X |
showUnread | 사용자별 읽지않은 메시지 수 정보 포함 여부 | Boolean | false | X |
showLastMessage | 채널 마지막 메시지 정보 포함 여부 | Boolean | false | X |
name | 검색할 채널 이름(URL 인코딩 권장) | String | 없음 | X |
includeMembers | 참가자 검색 목록. 콤마(,)로 구분된 사용자 ID 문자열(공백 허용 안함)로 참가자들이 포함된 채널을 검색합니다. AND 조건입니다. (URL 인코딩 권장) | String | 없음 | X |
next | 다음 페이지 키 | String | 없음 | X |
- Swift
public func getJoinedChannelList( limit: Int = 15,
showMembers: Bool = true,
showManagers: Bool = true,
showReadReceipt: Bool = true,
showDeliveryReceipt: Bool = true,
showUnread: Bool = true,
showLastMessage: Bool = true,
name: String? = nil,
includeMembers: String? = nil,
next: String? = nil,
completion: ((ChannelPage?, Int) -> ())? = nil)
그룹 채널 정보
주의
사용자가 참가한 채널만 조회할 수 있습니다.
Parameters
속성 | 설명 | 유형 | 기본값 | 필수여부 |
---|---|---|---|---|
channelId | 채널 아이디 | String | 없음 | O |
- Swift
public func getChannel(channelId: String, completion: ((GroupChannel?, Int) -> ())? = nil)