AddonSession

@PublicApi
public interface AddonSession

Một phiên tiện ích bổ sung.

Chứa các phương thức phổ biến của tất cả các phiên của tiện ích bổ sung. Để sử dụng tính năng cùng xem và cùng làm, hãy gọi getCoWatching và getCoDoing tương ứng.

Tóm tắt

Các loại lồng nhau

Trình tạo cho AddonSession.

Phương thức công khai
abstract ListenableFuture<Void>

Kết thúc phiên tiện ích bổ sung và ngắt kết nối khỏi ứng dụng Meet.
abstract void

Thoát khỏi trạng thái bị tạm ngưng.
abstract CoDoingClient

Trả về thực thể CoDoingClient.
abstract CoWatchingClient

Trả về thực thể CoWatchingClient.
abstract AddonMeetingInfo

Trả về thông tin về cuộc họp đã kết nối, chẳng hạn như URL của cuộc họp.
abstract boolean

Trả về true nếu phiên đã kết thúc.
abstract boolean

Cho biết phiên có bị tạm ngưng hay không.
abstract void

Đặt lại trạng thái bắt đầu của tiện ích bổ sung.
abstract void

Tạm ngưng phiên tiện ích bổ sung.
abstract void

Cập nhật trạng thái bắt đầu của tiện ích bổ sung.
abstract void
updateParticipantMetadata(byte[] metadata)

Cập nhật siêu dữ liệu cho người tham gia này.

Phương thức công khai

endSession

abstract ListenableFuture<Void> endSession()

Kết thúc phiên tiện ích bổ sung và ngắt kết nối khỏi ứng dụng Meet. Thao tác này không buộc Meet kết thúc cuộc họp và cũng không khiến người dùng rời khỏi cuộc họp.

Nếu phiên đã kết thúc, thì đây là phiên không hoạt động; nó sẽ không gửi một trường hợp ngoại lệ.

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

một ListenableFuture đánh giá là thành công hoặc AddonException nếu có lỗi không mong muốn

endSuspension

abstract void endSuspension()

Thoát khỏi trạng thái bị tạm ngưng. Ứng dụng tiện ích bổ sung một lần nữa có thể gửi và nhận nội dung cập nhật.

Nếu không ở trạng thái tạm ngưng thì đây là trang không hoạt động.

Gửi
java.lang.IllegalStateException

nếu phiên hoạt động đã kết thúc. Đây có thể là một lệnh gọi rõ ràng đến endSession hoặc có thể do một lý do bên ngoài nào đó sẽ hiển thị qua onSessionEnded.

getCoDoing

abstract CoDoingClient getCoDoing()

Trả về thực thể CoDoingClient.

Gửi
java.lang.IllegalStateException

nếu phiên được tạo mà không gọi withCoDoing hoặc nếu phiên đã kết thúc

getCoWatching

abstract CoWatchingClient getCoWatching()

Trả về thực thể CoWatchingClient.

Gửi
java.lang.IllegalStateException

nếu phiên được tạo mà không gọi withCoWatching hoặc nếu phiên đã kết thúc

getMeetingInfo

abstract AddonMeetingInfo getMeetingInfo()

Trả về thông tin về cuộc họp đã kết nối, chẳng hạn như URL của cuộc họp.

Gửi
java.lang.IllegalStateException

nếu phiên hoạt động đã kết thúc. Đây có thể là một lệnh gọi rõ ràng đến endSession hoặc có thể do một lý do bên ngoài nào đó sẽ hiển thị qua onSessionEnded.

isSessionEnded

abstract boolean isSessionEnded()

Trả về true nếu phiên đã kết thúc. Điều này có thể là từ một lệnh gọi rõ ràng đến endSession hoặc có thể là do một lý do bên ngoài nào đó sẽ hiển thị qua onSessionEnded.

Gửi
java.lang.IllegalStateException

nếu phiên hoạt động đã kết thúc. Đây có thể là một lệnh gọi rõ ràng đến endSession hoặc có thể do một lý do bên ngoài nào đó sẽ hiển thị qua onSessionEnded

isSuspended

abstract boolean isSuspended()

Cho biết phiên có bị tạm ngưng hay không. Hãy xem suspend và endSuspension.

Gửi
java.lang.IllegalStateException

nếu phiên hoạt động đã kết thúc. Đây có thể là một lệnh gọi rõ ràng đến endSession hoặc có thể do một lý do bên ngoài nào đó sẽ hiển thị qua onSessionEnded.

resetCollaborationStartingState

abstract void resetCollaborationStartingState()

Đặt lại trạng thái bắt đầu của tiện ích bổ sung. Thao tác này sẽ xoá trạng thái bắt đầu mà những người tham gia khác nhận được trước đó. Chỉ trình khởi tạo mới có thể đặt lại trạng thái bắt đầu.

suspend

abstract void suspend()

Tạm ngưng phiên tiện ích bổ sung. Thao tác này KHÔNG ngắt kết nối khỏi ứng dụng Meet. Điều này khiến SDK tránh gửi bản cập nhật cho CoDoingHandler và CoWatchingHandler của bạn, đồng thời khiến SDK bỏ qua lệnh gọi để thông báo cuộc gọi và bỏ qua cuộc gọi nhằm cập nhật trạng thái chung.

Nếu phiên đã bị tạm ngưng, thì phiên này không hoạt động.

Ví dụ: bạn có thể chọn gọi suspend khi một người dùng (chứ không phải tất cả người dùng) đều bị gián đoạn quá trình phát để xem quảng cáo, khi người dùng chạy ứng dụng ở chế độ nền, v.v.

Gửi
java.lang.IllegalStateException

nếu phiên hoạt động đã kết thúc. Đây có thể là một lệnh gọi rõ ràng đến endSession hoặc có thể do một lý do bên ngoài nào đó sẽ hiển thị qua onSessionEnded.

updateCollaborationStartingState

abstract void updateCollaborationStartingState(
    CollaborationStartingState startingState
)

Cập nhật trạng thái bắt đầu của tiện ích bổ sung. Những người tham gia khác sẽ nhận được thư mời này khi họ chấp nhận lời mời cộng tác. Chỉ trình khởi tạo mới có thể cập nhật trạng thái bắt đầu.

Thông số
CollaborationStartingState startingState

trạng thái ban đầu của tiện ích bổ sung

updateParticipantMetadata

abstract void updateParticipantMetadata(byte[] metadata)

Cập nhật siêu dữ liệu cho người tham gia này.

Để nhận siêu dữ liệu từ những người tham gia khác, bạn phải đăng ký trình xử lý bằng cách gọi withPARTICIPANTMetadata trong khi tạo AddonSession.

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ố
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.IllegalStateException

nếu phiên hoạt động đã kết thúc. Đây có thể là một lệnh gọi rõ ràng đến endSession hoặc có thể do một lý do bên ngoài nào đó sẽ hiển thị qua onSessionEnded.