Skip to Content
Nazu

client

클래스

클래스설명
ArisaClientArisa 서버에 연결해 이벤트를 받고 채팅방과 유저를 조회하는 클라이언트

타입 별칭

ArisaClientOptions

type ArisaClientOptions = object;

ArisaClient 생성자 옵션

속성

속성수정자타입기본값설명
botName?readonlystringundefined이벤트의 UserSelf에 표시할 내 이름. 대시보드에는 쓰지 않습니다.
dashboard?readonlybooleantruestart()할 때 대시보드도 켤지 여부
dashboardPort?readonlynumber3001대시보드 포트
openProfileIntervalMs?readonlynumber1500오픈프로필 변경을 확인하는 간격(밀리초)
target?readonlystring127.0.0.1:3000Arisa gRPC 서버 주소. 비우거나 공백만 넣으면 기본값을 씁니다.

DeleteListener

type DeleteListener = (chat, channel) => void | Promise<void>;

delete 이벤트 리스너. 메세지가 삭제되면 호출하고, 원본을 찾지 못하면 호출하지 않습니다.

매개변수

매개변수타입
chatDeleteFeedChat
channelChannel

반환값

void | Promise<void>

EditListener

type EditListener = (chat, channel) => void | Promise<void>;

edit 이벤트 리스너. 메세지가 수정되면 호출하고, 수정 전 메세지를 찾지 못하면 호출하지 않습니다.

매개변수

매개변수타입
chatEditFeedChat
channelChannel

반환값

void | Promise<void>

ErrorContext

type ErrorContext = object;

error 이벤트로 전달되는 오류 정보

속성

속성수정자타입설명
argsreadonlyreadonly unknown[]오류가 났을 때 리스너에 전달된 인자
eventreadonlystring오류가 난 이벤트 이름. 연결 중 오류는 connect
exceptionreadonlyunknown발생한 오류
funcreadonlyunknown오류가 난 리스너 함수. 리스너 밖에서 난 오류는 null

ErrorListener

type ErrorListener = (error) => void | Promise<void>;

error 이벤트 리스너. 이벤트 처리나 연결 중 오류가 나면 호출합니다. 오류 리스너가 없거나 리스너 안에서 다시 오류가 나면 콘솔에 출력합니다.

매개변수

매개변수타입
errorErrorContext

반환값

void | Promise<void>

FeedListener

type FeedListener = (chat, channel) => void | Promise<void>;

feed 이벤트 리스너. 입장, 퇴장, 삭제 같은 피드를 모두 받습니다. 알 수 없는 피드는 UnknownFeedChat으로 전달합니다.

매개변수

매개변수타입
chatFeedChat
channelChannel

반환값

void | Promise<void>

HideListener

type HideListener = (chat, channel) => void | Promise<void>;

hide 이벤트 리스너. 방장이나 부방장이 메세지를 가리면 호출합니다.

매개변수

매개변수타입
chatHideFeedChat
channelChannel

반환값

void | Promise<void>

InviteListener

type InviteListener = (chat, channel) => void | Promise<void>;

invite 이벤트 리스너. 일반 채팅방에 유저가 초대되면 호출합니다.

매개변수

매개변수타입
chatInviteFeedChat
channelChannel

반환값

void | Promise<void>

JoinListener

type JoinListener = (chat, channel) => void | Promise<void>;

join 이벤트 리스너. 오픈채팅방에 유저가 들어오면 호출합니다.

매개변수

매개변수타입
chatJoinFeedChat
channelChannel

반환값

void | Promise<void>

KickListener

type KickListener = (chat, channel) => void | Promise<void>;

kick 이벤트 리스너. 오픈채팅방에서 유저가 강퇴되면 호출합니다. 팀채팅 강퇴는 leave로 받습니다.

매개변수

매개변수타입
chatKickFeedChat
channelChannel

반환값

void | Promise<void>

LeaveListener

type LeaveListener = (chat, channel) => void | Promise<void>;

leave 이벤트 리스너. 유저가 채팅방을 나가면 호출합니다.

매개변수

매개변수타입
chatLeaveFeedChat
channelChannel

반환값

void | Promise<void>

MemberTypeChangeListener

type MemberTypeChangeListener = (chat, channel) => void | Promise<void>;

member_type_change 이벤트 리스너. 방장이 바뀌거나 부방장이 임명·해제되면 호출합니다.

매개변수

매개변수타입
chatMemberTypeChangeFeedChat
channelChannel

반환값

void | Promise<void>

MessageListener

type MessageListener = (chat, channel) => void | Promise<void>;

message 이벤트 리스너. 메세지가 도착하면 호출합니다.

매개변수

매개변수타입
chatMessageChat
channelChannel

반환값

void | Promise<void>

OpenProfileChange

type OpenProfileChange = object;

오픈프로필에서 바뀐 항목. 이름과 이미지가 모두 바뀌면 두 메서드 모두 true

메서드

isNickname()
isNickname(): boolean;

프로필 이름 변경 여부

반환값

boolean

isProfileImage()
isProfileImage(): boolean;

프로필 이미지 주소 변경 여부

반환값

boolean

OpenProfileChangeListener

type OpenProfileChangeListener = (beforeUser, afterUser, channel, change) => void | Promise<void>;

open_profile_change 이벤트 리스너. 오픈프로필 이름이나 이미지가 바뀌면 호출합니다.

리스너가 있는 동안 ArisaClientOptions.openProfileIntervalMs 간격으로 프로필을 확인합니다. 확인 사이에 여러 번 바뀌면 중간 변경은 놓칠 수 있습니다.

매개변수

매개변수타입
beforeUserOpenProfileChangeUser
afterUserOpenProfileChangeUser
channelChannel
changeOpenProfileChange

반환값

void | Promise<void>

OpenProfileChangeUser

type OpenProfileChangeUser = object;

open_profile_change 이벤트의 변경 전후 오픈프로필

속성

속성수정자타입설명
idreadonlystring유저 ID
namereadonlystring프로필 이름
profileImageUrlreadonlystring | null프로필 이미지 주소. 없으면 null

On this page