Class OpenChannel

Hierarchy

Channel
- OpenChannel
  - OpenMultiChannel
  - OpenDirectChannel

Index

Constructors

Properties

_customName _host _id _lastChat _members _name _openLink _raw

Accessors

customName host id lastChat members name openChannel openLink raw

Methods

get getChatCountGroupByUser getRecentChat isDirectChannel isGroupChannel isMultiChannel isOpenChannel isOpenDirectChannel isOpenMultiChannel read send toJSON get

Constructors

constructor

new OpenChannel(obj): OpenChannel
Parameters
- obj: ChannelCommon
Returns OpenChannel
Overrides Channel.constructor

Properties

`Protected` _customName

_customName: null | string

`Protected` _host

_host: User

`Protected` _id

_id: string

`Protected` _lastChat

_lastChat: Chat

`Protected` _members

_members: User[]

`Protected` _name

_name: string

`Protected` _openLink

_openLink: OpenLinkType

`Protected` _raw

_raw: ChannelCommon

Accessors

customName

get customName(): null | string
Returns null | string
Inherited from Channel.customName

host

get host(): User
방의 방장을 가져옵니다

Returns User
User|null

Overrides Channel.host

id

get id(): string
채널 아이디를 가져옵니다

Returns string
string

Inherited from Channel.id

lastChat

get lastChat(): Chat
방의 마지막 대화를 가져옵니다.

Returns Chat
Chat

Inherited from Channel.lastChat

members

get members(): User[]
현재 방의 인원을 가져옵니다

Returns User[]
User[]

Inherited from Channel.members

name

get name(): string
방의 이름을 가져옵니다

Returns string
string

Inherited from Channel.name
set name(name): void
Parameters
- name: string
Returns void
Inherited from Channel.name

openChannel

get openChannel(): OpenLinkType
오픈채팅 정보를 가져옵니다

Returns OpenLinkType
OpenLinkType
set openChannel(openLink): void
Parameters
- openLink: OpenLinkType
Returns void

openLink

get openLink(): OpenLinkType
오픈채팅 정보를 가져옵니다.

Returns OpenLinkType
OpenLinkType

raw

get raw(): ChannelType<"OM" | "OD", OpenChannelV>
방 데이터를 생으로 가져옵니다

Returns ChannelType<"OM" | "OD", OpenChannelV>
ChannelCommon

Overrides Channel.raw

Methods

get

get(i): null | Channel
체널아이디로 채널을 가져옵니다
Parameters
- i: string | number
Returns null | Channel
Channel|null

Inherited from Channel.get

getChatCountGroupByUser

getChatCountGroupByUser(options): ChannelCountInfo[]
유저별 채팅 수를 구합니다.
Parameters
- options: CountOption
Returns ChannelCountInfo[]
Inherited from Channel.getChatCountGroupByUser

getRecentChat

getRecentChat(count?): Chat[]
대화 내역을 가져옵니다.
Parameters
- count: number = 1
Returns Chat[]
Chat[]

Inherited from Channel.getRecentChat

isDirectChannel

isDirectChannel(): this is DirectChannel
Returns this is DirectChannel
Inherited from Channel.isDirectChannel

isGroupChannel

isGroupChannel(): boolean
여러명이 있는 방인 여부

Returns boolean
boolean

Inherited from Channel.isGroupChannel

isMultiChannel

isMultiChannel(): this is MultiChannel
Returns this is MultiChannel
Inherited from Channel.isMultiChannel

isOpenChannel

isOpenChannel(): this is OpenChannel
오픈챗방 여부

Returns this is OpenChannel
boolean

Inherited from Channel.isOpenChannel

isOpenDirectChannel

isOpenDirectChannel(): this is OpenDirectChannel
Returns this is OpenDirectChannel
Inherited from Channel.isOpenDirectChannel

isOpenMultiChannel

isOpenMultiChannel(): this is OpenMultiChannel
Returns this is OpenMultiChannel
Inherited from Channel.isOpenMultiChannel

read

read(): boolean
읽기 처리를 합니다

Returns boolean
boolean

Inherited from Channel.read

send

send(message): Promise<boolean>
방에다가 메시지를 전송합니다.
Parameters
- message: string
Returns Promise<boolean>
Promise

Inherited from Channel.send

toJSON

toJSON(): {
channel: ChannelCommon;
openLink: OpenLinkType;
}
Returns {
channel: ChannelCommon;
openLink: OpenLinkType;
}
- channel: ChannelCommon
- openLink: OpenLinkType
Overrides Channel.toJSON

`Static` get

get(i): null | Channel
체널아이디로 채널을 가져옵니다
Parameters
- i: string | number
Returns null | Channel
Channel|null

Inherited from Channel.get

Generated using TypeDoc