Skip to Content
Nazu

NormalChannel

일반 채팅방. 나와의 채팅은 name에 내 프로필 닉네임이 들어 있습니다.

확장

속성

속성수정자타입설명오버라이드 대상:상속받은 타입:
idreadonlystring채팅방 ID-Channel.id
namereadonlystring | null채팅방 이름-Channel.name
openChannelreadonlyOpenChannelInfo | null오픈채팅방 정보. 일반 채팅방이면 null-Channel.openChannel
privateNamereadonlystring | null채팅방 이름 설정에서 내가 지정한 이름-Channel.privateName
rawreadonlyChannelRaw채팅방 원본 데이터-Channel.raw
typereadonlyNormalChannelType일반 채팅방 종류Channel.type-

접근자

botUsers

get 시그니쳐

get botUsers(): Promise<BotUser[]>;

채팅방에 추가된 챗봇 목록

반환값

Promise<BotUser[]>

상속받은 타입:

Channel.botUsers

host

get 시그니쳐

get host(): Promise<User | null>;

방장. 방장이 없는 채팅방이거나 찾지 못하면 null

반환값

Promise<User | null>

상속받은 타입:

Channel.host

memberIds

get 시그니쳐

get memberIds(): Promise<string[]>;

지금 채팅방에 있는 멤버 ID 목록

반환값

Promise<string[]>

상속받은 타입:

Channel.memberIds

members

get 시그니쳐

get members(): Promise<User[]>;

지금 채팅방에 있는 멤버 목록

반환값

Promise<User[]>

상속받은 타입:

Channel.members

moderators

get 시그니쳐

get moderators(): Promise<User[]>;

부방장 목록. 부방장이 없는 채팅방이면 빈 배열

반환값

Promise<User[]>

상속받은 타입:

Channel.moderators

메서드

enter()

enter(): Promise<void>;

채팅방에 입장합니다.

반환값

Promise<void>

상속받은 타입:

Channel.enter

getChat()

getChat(logId): Promise<MessageChat>;

로그 ID로 메세지를 조회합니다.

매개변수

매개변수타입설명
logIdstring메세지 로그 ID

반환값

Promise<MessageChat>

Throws

클라이언트와 연결되지 않은 채팅방 객체에서 호출할 때

상속받은 타입:

Channel.getChat

getChatCountsByUser()

getChatCountsByUser(options?): Promise<ChatCount<User>[]>;

기간 안에 유저마다 보낸 채팅 수를 셉니다. 조회되지 않은 유저는 결과에서 빠집니다.

매개변수

매개변수타입설명
options?ChatCountOptions집계 기간과 피드 포함 여부. 생략하면 처음부터 지금까지 피드 없이 셉니다.

반환값

Promise<ChatCount<User>[]>

Throws

날짜가 올바르지 않거나 startDate가 endDate보다 늦을 때

상속받은 타입:

Channel.getChatCountsByUser

getChats()

getChats(logIds): Promise<MessageChat[]>;

여러 로그 ID로 메세지를 한꺼번에 조회합니다.

매개변수

매개변수타입설명
logIdsstring[]메세지 로그 ID 목록

반환값

Promise<MessageChat[]>

Throws

클라이언트와 연결되지 않은 채팅방 객체에서 호출할 때

상속받은 타입:

Channel.getChats

getRecentChats()

getRecentChats(count?): Promise<MessageChat[]>;

최근 메세지를 조회합니다. 메세지가 없으면 빈 배열을 돌려줍니다.

매개변수

매개변수타입기본값설명
count?number1조회할 메세지 수. 소수점 아래는 버립니다.

반환값

Promise<MessageChat[]>

Throws

count가 유한한 수가 아니거나 소수점 아래를 버린 값이 1보다 작을 때

상속받은 타입:

Channel.getRecentChats

isCommunityOpenMultiChannel()

isCommunityOpenMultiChannel(): boolean;

커뮤니티 오픈 그룹 채팅(COM) 여부

반환값

boolean

상속받은 타입:

Channel.isCommunityOpenMultiChannel

isDirectChannel()

isDirectChannel(): boolean;

일반 1:1 채팅(DirectChat) 여부

반환값

boolean

상속받은 타입:

Channel.isDirectChannel

isMemoChannel()

isMemoChannel(): boolean;

나와의 채팅(MemoChat) 여부

반환값

boolean

상속받은 타입:

Channel.isMemoChannel

isMultiChannel()

isMultiChannel(): boolean;

일반 그룹 채팅(MultiChat) 여부

반환값

boolean

상속받은 타입:

Channel.isMultiChannel

isNormalChannel()

isNormalChannel(): this is NormalChannel;

일반 채팅방 여부

반환값

this is NormalChannel

상속받은 타입:

Channel.isNormalChannel

isOpenChannel()

isOpenChannel(): this is OpenChannel;

오픈채팅방 여부

반환값

this is OpenChannel

상속받은 타입:

Channel.isOpenChannel

isOpenDirectChannel()

isOpenDirectChannel(): boolean;

1:1 오픈채팅(OD) 여부

반환값

boolean

상속받은 타입:

Channel.isOpenDirectChannel

isOpenMultiChannel()

isOpenMultiChannel(): boolean;

그룹 오픈채팅(OM) 여부

반환값

boolean

상속받은 타입:

Channel.isOpenMultiChannel

isPlusChannel()

isPlusChannel(): boolean;

카카오톡 채널(PlusChat) 여부

반환값

boolean

상속받은 타입:

Channel.isPlusChannel

isTeamMultiChannel()

isTeamMultiChannel(): boolean;

팀채팅(TeamMultiChat) 여부

반환값

boolean

상속받은 타입:

Channel.isTeamMultiChannel

read()

read(): Promise<void>;

채팅방을 읽음 처리합니다.

반환값

Promise<void>

상속받은 타입:

Channel.read

send()

send(message, threadId?): Promise<void>;

채팅방에 메세지를 보냅니다.

매개변수

매개변수타입설명
messagestring보낼 메세지
threadId?string | null스레드에 보낼 때 스레드 ID

반환값

Promise<void>

상속받은 타입:

Channel.send

sendMedia()

sendMedia(files, options?): Promise<void>;

채팅방에 파일을 보냅니다. 파일 경로, URL, 바이트, MediaFile을 넣을 수 있습니다.

options.mode를 생략하면 하나는 single, 배열은 multiple로 보냅니다.

매개변수

매개변수타입설명
files| MediaInput | MediaInput[]보낼 파일이나 파일 목록
options?SendMediaOptions전송 방식

반환값

Promise<void>

Throws

files가 빈 배열일 때

상속받은 타입:

Channel.sendMedia

On this page