시작하기

VChatCloud SDK는 VChatCloud 서비스를 Flutter프레임워크를 사용해 간편하게 구현할 수 있게 해주는 개발 키트입니다.

채팅 기능이 있는 앱을 구축하려는 경우 샘플 앱 위에 클라이언트 앱을 구축하는 것이 좋습니다. 만약 이미 앱이 있고 채팅을 추가하려는 경우 이 안내서를 진행하여 채팅을 앱에 통합합니다. 이 안내서는 앱에 채팅 SDK를 설치하고 채널 객체를 생성하고 첫 번째 메시지를 보내는 과정을 안내합니다.

샘플 앱을 사용하려는 경우에는 이곳을 눌러 이동하세요.

시작하기 전에

먼저 CMS에서 채팅방을 생성해야 합니다. 만약 채팅방이 이미 생성되어 있다면 ChannelKey값을 확인하세요.
새로 생성하려면 이곳을 눌러 이동하세요.

첫 메시지 보내기

종속성 추가하기

종속성은 pubspec.yaml에 직접 입력하거나 명령어를 사용해서 추가할 수 있습니다.

<project_root>/pubspec.yaml에 해당 내용을 추가합니다.

dependencies:
  vchatcloud_flutter_sdk: ^1.0.2

터미널에 아래 명령어를 입력합니다.

flutter pub get

터미널에 아래 명령어를 입력합니다.

flutter pub add vchatcloud_flutter_sdk

패키지 불러오기

sdk를 사용할 곳에서 아래 문구를 추가하여 패키지를 불러옵니다.

import 'package:vchatcloud_flutter_sdk/vchatcloud_flutter_sdk.dart'

SDK 초기화하기

이벤트 핸들러을 참조하여 새로운 Handler를 구현한 뒤 SDK를 초기화하고 Channel객체를 가져옵니다. 그 후 CMS에서 확인한 ChannelKey를 확인하여 UserModel객체를 생성해 채팅방에 접속합니다.

void main() async {
  var channel = VChatCloud.connect(CustomHandler());
  var history = await channel.join(UserModel(
    roomId: "YOUR_CHANNEL_KEY",
    nickName: "USER_NICKNAME",
    userInfo: {"profile":"PROFILE_IMAGE_INDEX"}, // {"profile": "1"} >> 1번 프로필 이미지 사용
    clientKey: "USER_UNIQUE_KEY",
  ));
}

메시지 보내기

Channel객체의 sendMessage메서드를 이용해 메시지를 전송합니다.

channel.sendMessage("Hello VChatCloud!");