AddonSession.Builder

@PublicApi
public interface AddonSession.Builder



Trình tạo cho AddonSession. Vui lòng xem newSessionBuilder.

Tóm tắt

Phương thức công khai

abstract ListenableFuture<AddonSession>
begin(Context appContext)

Bắt đầu phiên tiện ích bổ sung.

abstract AddonSession.Builder

Thêm việc cùng làm vào phiên tiện ích bổ sung có trạng thái ban đầu.

abstract AddonSession.Builder
@CanIgnoreReturnValue
withCoDoing(
    CoDoingHandler coDoingHandler,
    Optional<CoDoingState> initiatorInitialState
)

Thêm việc cùng làm vào phiên tiện ích bổ sung.

abstract AddonSession.Builder

Thêm tính năng cùng xem vào phiên tiện ích bổ sung.

abstract AddonSession.Builder
@CanIgnoreReturnValue
withCoWatching(
    CoWatchingHandler coWatchingHandler,
    Optional<CoWatchingState> initiatorInitialState
)

Thêm tính năng cùng xem vào phiên tiện ích bổ sung có trạng thái ban đầu.

abstract AddonSession.Builder

Đặt CollaborationStartingState cho phiên.

abstract AddonSession.Builder

Đăng ký trình nghe để cập nhật siêu dữ liệu cho những người tham gia khác.

abstract AddonSession.Builder

Đặt siêu dữ liệu cho người tham gia này và đăng ký trình nghe để cập nhật thông tin cho những người tham gia khác.

Phương thức công khai

bắt đầu

abstract ListenableFuture<AddonSessionbegin(Context appContext)

Bắt đầu phiên tiện ích bổ sung. Lệnh này chỉ nên được gọi sau khi người dùng xác nhận rằng họ muốn tham gia một phiên tiện ích bổ sung.

Kết nối với một cuộc họp, bằng cách tạo một cuộc họp hoặc bằng cách kết nối với một cuộc họp đang diễn ra. Lưu ý:

  • Nếu cuộc họp được tạo thì người dùng hiện tại sẽ là người tham gia duy nhất ban đầu.
  • Bạn có thể truy cập thông tin chi tiết về cuộc họp qua getMeetingInfo trong phiên được trả về.
  • URL được trả về sẽ hiển thị cho người dùng và được chia sẻ theo cách thủ công với nhóm phiên hoạt động của tiện ích bổ sung mà họ dự định sử dụng.
Bạn có thể truy cập vào các thực thể cùng xem và cùng làm thông qua getCoWatchinggetCoDoing tương ứng.

Bạn không nên gọi cancel trong tương lai này, mà thay vào đó hãy cho phép lệnh chạy hoàn tất.

Thông số
Context appContext

giá trị getApplicationContext của ứng dụng đang sử dụng SDK

Giá trị trả về
ListenableFuture<AddonSession>

một ListenableFuture đánh giá cho một thực thể AddonSession thuộc loại thích hợp nếu một phiên tiện ích bổ sung được bắt đầu thành công. Ngược lại, hãy đánh giá thành IllegalStateException nếu một AddonSession khác vẫn đang chạy (ví dụ: endSession không được gọi) hoặc thành AddonException nếu xảy ra lỗi không mong muốn.

withCoDoing

@CanIgnoreReturnValue
abstract AddonSession.Builder withCoDoing(CoDoingHandler coDoingHandler)

Thêm việc cùng làm vào phiên tiện ích bổ sung có trạng thái ban đầu.

Thông số
CoDoingHandler coDoingHandler

lệnh gọi lại để cùng làm

Giá trị trả về
AddonSession.Builder

một thực thể trình tạo khác để tạo chuỗi

Gửi
java.lang.NullPointerException

nếu coDoingHandler rỗng

withCoDoing

@CanIgnoreReturnValue
abstract AddonSession.Builder withCoDoing(
    CoDoingHandler coDoingHandler,
    Optional<CoDoingState> initiatorInitialState
)

Thêm việc cùng làm vào phiên tiện ích bổ sung.

Thông số
CoDoingHandler coDoingHandler

lệnh gọi lại để cùng làm

Optional<CoDoingState> initiatorInitialState

trạng thái ban đầu của trình khởi tạo. Thao tác này sẽ bị bỏ qua nếu người dùng đang tham gia một phiên hiện có

Giá trị trả về
AddonSession.Builder

một thực thể trình tạo khác để tạo chuỗi

Gửi
java.lang.NullPointerException

nếu coDoingHandler hoặc initiatorInitialState rỗng

withCoWatching

@CanIgnoreReturnValue
abstract AddonSession.Builder withCoWatching(CoWatchingHandler coWatchingHandler)

Thêm tính năng cùng xem vào phiên tiện ích bổ sung.

Thông số
CoWatchingHandler coWatchingHandler

lệnh gọi lại để cùng xem

Giá trị trả về
AddonSession.Builder

một thực thể trình tạo khác để tạo chuỗi

Gửi
java.lang.NullPointerException

nếu coWatchingHandler rỗng

withCoWatching

@CanIgnoreReturnValue
abstract AddonSession.Builder withCoWatching(
    CoWatchingHandler coWatchingHandler,
    Optional<CoWatchingState> initiatorInitialState
)

Thêm tính năng cùng xem vào phiên tiện ích bổ sung có trạng thái ban đầu.

Thông số
CoWatchingHandler coWatchingHandler

lệnh gọi lại để cùng xem

Optional<CoWatchingState> initiatorInitialState

trạng thái ban đầu của trình khởi tạo. Thao tác này sẽ bị bỏ qua nếu người dùng đang tham gia một phiên hiện có

Giá trị trả về
AddonSession.Builder

một thực thể trình tạo khác để tạo chuỗi

Gửi
java.lang.NullPointerException

nếu coWatchingHandler hoặc initiatorInitialState rỗng

withCollaborationStartingState

@CanIgnoreReturnValue
abstract AddonSession.Builder withCollaborationStartingState(
    CollaborationStartingState collaborationStartingState
)

Đặt CollaborationStartingState cho phiên.

Bạn có thể thay đổi chế độ này vào lúc khác bằng cách gọi updateCollaborationStartingState hoặc resetCollaborationStartingState.

Thông số
CollaborationStartingState collaborationStartingState

CollaborationStartingState dữ liệu

Gửi
java.lang.NullPointerException

nếu collaborationStartingState rỗng

withParticipantMetadata

@CanIgnoreReturnValue
abstract AddonSession.Builder withParticipantMetadata(ParticipantMetadataHandler handler)

Đăng ký trình nghe để cập nhật siêu dữ liệu cho những người tham gia khác.

Ban đầu, siêu dữ liệu của người tham gia cục bộ sẽ được đặt thành một giá trị trống, nhưng bạn có thể thiết lập siêu dữ liệu này sau bằng cách gọi updateParticipantMetadata. Để đặt giá trị ban đầu, hãy gọi withParticipantMetadata.

Thông số
ParticipantMetadataHandler handler

ParticipantMetadataHandler để nhận bộ siêu dữ liệu mới nhất về người tham gia mỗi khi được cập nhật

Gửi
java.lang.NullPointerException

nếu handler rỗng

withParticipantMetadata

@CanIgnoreReturnValue
abstract AddonSession.Builder withParticipantMetadata(
    ParticipantMetadataHandler handler,
    byte[] metadata
)

Đặt siêu dữ liệu cho người tham gia này và đăng ký trình nghe để cập nhật thông tin cho những người tham gia khác.

Bạn có thể thay đổi siêu dữ liệu này vào lúc khác bằng cách gọi updateParticipantMetadata.

Siêu dữ liệu được mã hoá bị giới hạn ở mức MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES byte cho mỗi người tham gia.

Thông số
ParticipantMetadataHandler handler

ParticipantMetadataHandler để nhận bộ siêu dữ liệu mới nhất về người tham gia mỗi khi được cập nhật

byte[] metadata

một blob siêu dữ liệu được mã hoá để mô tả siêu dữ liệu có liên quan cho người tham gia cục bộ

Gửi
java.lang.IllegalArgumentException

nếu siêu dữ liệu đã cung cấp vượt quá MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES byte

java.lang.NullPointerException

nếu handler rỗng