AddonSession.Builder 

@PublicApi
public interface AddonSession.Builder

Строитель для AddonSession . См. newSessionBuilder .

Краткое содержание

Публичные методы

abstract ListenableFuture < AddonSession >
begin ( Context appContext)

Начинает дополнительный сеанс.

abstract AddonSession.Builder

Добавляет совместное выполнение в дополнительный сеанс с исходным состоянием.

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

Добавляет совместное выполнение в дополнительный сеанс.

abstract AddonSession.Builder

Добавляет совместный просмотр в дополнительный сеанс.

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

Добавляет совместный просмотр в дополнительный сеанс с исходным состоянием.

abstract AddonSession.Builder

Устанавливает CollaborationStartingState для сеанса.

abstract AddonSession.Builder

Регистрирует прослушиватель обновлений метаданных других участников.

abstract AddonSession.Builder

Устанавливает метаданные для этого участника и регистрирует прослушиватель обновлений для других участников.

Публичные методы

начинать

abstract ListenableFuture<AddonSession> begin(Context appContext)

Начинает дополнительный сеанс. Это следует вызывать только после того, как пользователь подтвердил, что хочет участвовать в дополнительном сеансе.

Подключается к собранию либо путем создания собрания, либо путем подключения к текущему собранию. Примечания:

  • Если собрание создано, текущий пользователь изначально будет единственным участником.
  • Доступ к сведениям о собрании можно получить через getMeetingInfo в возвращенном сеансе.
  • Возвращенный URL-адрес предназначен для предоставления пользователю и передачи вручную его предполагаемой дополнительной группе сеансов.
Доступ к экземплярам совместного просмотра и совместного выполнения можно получить через getCoWatching и getCoDoing соответственно.

Не рекомендуется вызывать команду cancel в этом будущем, вместо этого рекомендуется разрешить ему завершиться.

Параметры
Context appContext

значение getApplicationContext приложения, использующего SDK.

Возврат
ListenableFuture < AddonSession >

ListenableFuture , который оценивается как экземпляр AddonSession соответствующего типа, если дополнительный сеанс был успешно запущен. В противном случае выдается исключение IllegalStateException , если другой AddonSession все еще выполняется (например, endSession не был вызван), или AddonException , если произошла непредвиденная ошибка.

сCoDoing

@CanIgnoreReturnValue
abstract AddonSession.Builder withCoDoing(CoDoingHandler coDoingHandler)

Добавляет совместное выполнение в дополнительный сеанс с исходным состоянием.

Параметры
CoDoingHandler coDoingHandler

обратные вызовы для совместной работы

Возврат
AddonSession.Builder

еще один экземпляр строителя для цепочки

Броски
java.lang.NullPointerException

если coDoingHandler имеет значение null

сCoDoing

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

Добавляет совместное выполнение в дополнительный сеанс.

Параметры
CoDoingHandler coDoingHandler

обратные вызовы для совместной работы

Optional < CoDoingState > initiatorInitialState

исходное состояние инициатора. Это будет проигнорировано, если пользователь присоединяется к существующему сеансу.

Возврат
AddonSession.Builder

еще один экземпляр строителя для цепочки

Броски
java.lang.NullPointerException

если coDoingHandler или initiatorInitialState имеет значение null

сCoWatching

@CanIgnoreReturnValue
abstract AddonSession.Builder withCoWatching(CoWatchingHandler coWatchingHandler)

Добавляет совместный просмотр в дополнительный сеанс.

Параметры
CoWatchingHandler coWatchingHandler

обратные вызовы для совместного просмотра

Возврат
AddonSession.Builder

еще один экземпляр строителя для цепочки

Броски
java.lang.NullPointerException

если coWatchingHandler имеет значение null

сCoWatching

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

Добавляет совместный просмотр в дополнительный сеанс с исходным состоянием.

Параметры
CoWatchingHandler coWatchingHandler

обратные вызовы для совместного просмотра

Optional < CoWatchingState > initiatorInitialState

исходное состояние инициатора. Это будет проигнорировано, если пользователь присоединяется к существующему сеансу.

Возврат
AddonSession.Builder

еще один экземпляр строителя для цепочки

Броски
java.lang.NullPointerException

если coWatchingHandler или initiatorInitialState имеет значение null

сколлаборатионстартингстате

@CanIgnoreReturnValue
abstract AddonSession.Builder withCollaborationStartingState(
    CollaborationStartingState collaborationStartingState
)

Устанавливает CollaborationStartingState для сеанса.

Это можно изменить позже, вызвав updateCollaborationStartingState или resetCollaborationStartingState .

Параметры
CollaborationStartingState collaborationStartingState

Данные CollaborationStartingState

Броски
java.lang.NullPointerException

если collaborationStartingState равно нулю

сParticipantMetadata

@CanIgnoreReturnValue
abstract AddonSession.Builder withParticipantMetadata(ParticipantMetadataHandler handler)

Регистрирует прослушиватель обновлений метаданных других участников.

Первоначально метаданным локального участника будет присвоено пустое значение, но его можно будет установить позже, вызвав updateParticipantMetadata . Чтобы установить начальное значение, вместо этого вызовите withParticipantMetadata .

Параметры
ParticipantMetadataHandler handler

ParticipantMetadataHandler для получения последнего набора метаданных участников при каждом его обновлении.

Броски
java.lang.NullPointerException

если handler равен нулю

сParticipantMetadata

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

Устанавливает метаданные для этого участника и регистрирует прослушиватель обновлений для других участников.

Эти метаданные можно изменить позже, вызвав updateParticipantMetadata .

Закодированные метаданные ограничены MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES байтами на участника.

Параметры
ParticipantMetadataHandler handler

ParticipantMetadataHandler для получения последнего набора метаданных участников при каждом его обновлении.

byte[] metadata

закодированный блок метаданных, который описывает соответствующие метаданные для локального участника

Броски
java.lang.IllegalArgumentException

если предоставленные метаданные превышают MAX_INDIVIDUAL_PARTICIPANT_METADATA_SIZE_BYTES байт

java.lang.NullPointerException

если handler равен нулю