고객 인터페이스

TIM

TIM은 IM Web SDK의 네임스페이스이며 SDK 인스턴스를 생성하기 위한 정적 메서드 create(), 이벤트 상수 EVENT 및 유형 상수 TYPES를 제공합니다.

초기화

API	설명
create	SDK 인스턴스 생성.

SDK 인스턴스

기본 개념	설명
Message(메시지)	IM SDK의 Message는 보낼 내용을 나타내며 발신자, 발신자 계정, 메시지 생성 시간 등을 지정하는 여러 속성을 전달합니다.
Conversation(대화)	IM SDK의 Conversation은 두 가지 유형을 사용할 수 있습니다. C2C(Client to Client): 두 명의 참가자만 참여하는 일대일 채팅입니다. GROUP(그룹): 두 명 이상의 참가자가 참여하는 그룹 채팅입니다.
Profile(프로필)	IM SDK의 Profile은 닉네임, 성별, 개인 서명, 프로필 사진 주소 등 사용자의 기본 정보를 설명합니다.
Friend(친구)	IM SDK의 Friend는 비고, 친구 목록 등 친구의 기본 정보를 설명합니다.
FriendApplication(친구 신청)	IM SDK의 FriendApplication은 친구 요청의 기본 정보와 친구 출처, 비고 등을 설명합니다.
FriendGroup(친구 그룹)	IM SDK의 FriendGroup은 친구 목록 이름 및 구성원을 포함하여 친구 목록의 기본 정보를 설명합니다.
Group(그룹)	IM SDK의 Group은 업무, 공개, 회의, AVChatRoom 등 그룹 채팅을 위한 커뮤니케이션 시스템을 의미합니다.
GroupMember(그룹 구성원)	IM SDK의 GroupMember는 ID, 닉네임, 역할, 그룹 가입 시간 등 각 그룹 구성원의 기본 정보를 나타냅니다.
그룹 알림	그룹 구성원 추가 또는 삭제와 같은 이벤트가 발생하면 그룹 알림이 생성됩니다. 액세스 측은 그룹 구성원에게 그룹 알림을 표시할지 여부를 구성할 수 있습니다. 그룹 알림 유형에 대한 자세한 내용은 Message.GroupTipPayload를 참고하십시오.
그룹 시스템 메시지	예를 들어 사용자가 그룹 가입을 요청하면 그룹 관리자는 시스템 메시지를 받습니다. 관리자가 요청을 수락하거나 거부하면 IM SDK는 결과를 액세스 측에 반환한 다음 결과를 사용자에게 표시합니다. 그룹 시스템 메시지 유형에 대한 자세한 내용은 Message.GroupSystemNoticePayload를 참고핫십시오.
화면에 메시지 표시	텍스트 세그먼트 및 이미지를 포함하여 보낸 메시지는 컴퓨터 또는 휴대폰 화면에 표시됩니다.

이벤트

API	설명
on	이벤트 수신을 활성화합니다.
off	이벤트 수신을 비활성화합니다.

플러그인 등록

API	설명
registerPlugin	플러그인을 등록합니다.

로그 레벨 설정

API	설명
setLogLevel	로그 레벨을 설정합니다.

SDK 인스턴스 종료

API	설명
destroy	인스턴스를 종료합니다.

로그인

API	설명
login	로그인합니다.
logout	로그아웃합니다.

메시지

API	설명
createTextMessage	텍스트 메시지를 생성합니다.
createTextAtMessage	@ 알림 기능으로 문자 메시지를 작성합니다.
createImageMessage	이미지 메시지를 생성합니다.
createAudioMessage	음성 메시지를 생성합니다.
createVideoMessage	비디오 메시지를 생성합니다.
createCustomMessage	사용자 정의 메시지를 생성합니다.
createFaceMessage	이모티콘 메시지를 생성합니다.
createFileMessage	파일 메시지를 생성합니다.
createLocationMessage	지리적 위치 메시지를 생성합니다.
createMergerMessage	결합된 메시지를 생성합니다.
downloadMergerMessage	결합된 메시지를 다운로드합니다.
createForwardMessage	포워딩 메시지를 생성합니다.
sendMessage	메시지를 보냅니다.
revokeMessage	메시지를 회수합니다.
resendMessage	메시지를 다시 보냅니다.
deleteMessage	메시지를 삭제합니다.
setMessageExtensions	메시지 확장을 설정합니다.
getMessageExtensions	메시지 확장을 가져옵니다.
deleteMessageExtensions	메시지 확장을 삭제합니다.

대화

API	설명
modifyMessage	메시지를 수정합니다.
getMessageList	메시지 목록을 가져옵니다.
getMessageListHopping	지정된 sequence 또는 시간 범위로 대화 메시지 목록을 가져옵니다.
sendMessageReadReceipt	메시지 수신 확인을 보냅니다.
getMessageReadReceiptList	메시지 수신 확인 목록을 풀링합니다.
getGroupMessageReadMemberList	그룹 메시지를 읽은(또는 읽지 않은) 구성원 목록을 가져옵니다.
findMessage	지정된 대화의 로컬 메시지를 messageID로 쿼리합니다.
setMessageRead	메시지를 읽은 상태로 설정합니다.
getConversationList	대화 목록을 가져옵니다.
getConversationProfile	대화 정보를 가져옵니다.
deleteConversation	대화를 삭제합니다.
clearHistoryMessage	일대일 또는 그룹 채팅의 로컬 및 클라우드 메시지를 지웁니다(대화는 삭제하지 않음).
pinConversation	대화를 상단에 고정/고정 해제합니다.
setAllMessageRead	모든 대화의 읽지 않은 메시지를 읽은 것으로 표시합니다.
setMessageRemindType	대화 메시지 알림 유형을 설정합니다. 이 API를 사용하여 ‘알림을 음소거’하거나 ‘메시지를 거부’할 수 있습니다.
getTotalUnreadMessageCount	읽지 않은 세션의 총 수를 가져옵니다.

대화 그룹

API	설명
setConversationCustomData	사용자 정의 대화 데이터를 설정합니다.
markConversation	대화를 표시합니다.
getConversationGroupList	대화 그룹 목록을 가져옵니다.
createConversationGroup	대화 그룹을 생성합니다.
deleteConversationGroup	대화 그룹을 삭제합니다.
renameConversationGroup	대화 그룹의 이름을 변경합니다.
addConversationsToGroup	대화를 대화 그룹에 추가합니다.
deleteConversationsFromGroup	대화 그룹에서 대화를 삭제합니다.

프로필

API	설명
getMyProfile	개인 프로필을 가져옵니다.
getUserProfile	다른 사용자의 프로필을 가져옵니다.
updateMyProfile	개인 프로필을 업데이트합니다.
getBlacklist	블록리스트를 가져옵니다.
addToBlacklist	블록리스트에 사용자를 추가합니다.
removeFromBlacklist	블록리스트에서 사용자를 제거합니다.

사용자 상태

API	설명
setSelfStatus	자신의 사용자 지정 상태를 설정합니다.
getUserStatus	사용자의 상태를 쿼리합니다.
subscribeUserStatus	사용자의 상태를 구독합니다.
unsubscribeUserStatus	사용자의 상태 구독을 취소합니다.

관계 체인

API	설명
getFriendList	SDK 캐시에 있는 친구 목록을 가져옵니다.
addFriend	친구를 추가합니다.
deleteFriend	친구를 삭제합니다.
checkFriend	친구를 인증합니다.
getFriendProfile	지정된 사용자의 친구 데이터 및 프로필 데이터를 가져옵니다.
updateFriend	친구의 관계 체인 데이터를 업데이트합니다.
getFriendApplicationList	SDK 캐시에 있는 친구 요청 목록을 가져옵니다.
acceptFriendApplication	친구 요청을 수락합니다.
refuseFriendApplication	친구 요청을 거부합니다.
deleteFriendApplication	친구 요청을 삭제합니다.
setFriendApplicationRead	친구 요청을 읽음으로 설정합니다.
getFriendGroupList	SDK 캐시에서 친구 목록을 가져옵니다.
createFriendGroup	친구 목록을 생성합니다.
deleteFriendGroup	친구 목록을 삭제합니다.
addToFriendGroup	친구 목록에 친구를 추가합니다.
removeFromFriendGroup	친구 목록에서 친구를 제거합니다.
renameFriendGroup	친구 목록의 이름을 수정합니다.

그룹

API	설명
getGroupList	그룹 목록을 가져옵니다.
getGroupProfile	그룹 프로필을 가져옵니다.
createGroup	그룹을 생성합니다.
dismissGroup	그룹을 삭제합니다.
updateGroupProfile	그룹 프로필을 수정합니다.
joinGroup	그룹 가입을 신청합니다.
quitGroup	그룹을 종료합니다.
searchGroupByID	그룹을 검색합니다.
getGroupOnlineMemberCount	라이브 방송 그룹의 온라인 사용자 수를 가져옵니다.
changeGroupOwner	그룹 소유권을 이전합니다.
getGroupApplicationList	그룹 가입 신청 목록을 가져옵니다.
handleGroupApplication	그룹 가입 요청을 처리합니다.
initGroupAttributes	그룹 속성을 초기화합니다.
setGroupAttributes	그룹 속성을 설정합니다.
deleteGroupAttributes	그룹 속성을 삭제합니다.
getGroupAttributes	그룹 속성을 가져옵니다.

그룹 구성원

API	설명
getGroupMemberList	그룹 구성원 목록을 가져옵니다.
getGroupMemberProfile	그룹 구성원의 프로필을 가져옵니다.
addGroupMember	그룹 구성원을 추가합니다.
deleteGroupMember	그룹 구성원을 삭제합니다.
setGroupMemberMuteTime	음소거 기간을 구성합니다.
setGroupMemberRole	그룹 구성원의 역할을 수정합니다.
setGroupMemberNameCard	그룹 구성원의 이름 카드를 설정합니다.
setGroupMemberCustomField	그룹 구성원에 대한 사용자 정의 필드를 설정합니다.
markGroupMemberList	그룹 구성원을 표시합니다.

주제

API	설명
getJoinedCommunityList	현재 사용자가 가입한 커뮤니티 그룹 목록을 가져옵니다.
createTopicInCommunity	주제를 생성합니다.
deleteTopicFromCommunity	주제를 삭제합니다.
updateTopicProfile	주제 프로필을 업데이트합니다.
getTopicList	주제 목록을 가져옵니다.

TIM
SDK 인스턴스