Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- AccessControlCallback - Interface in com.teamviewer.sdk.screensharing
-
Callback for authentication of access control requests from the remote supporter.
- AccessControlData - Interface in com.teamviewer.sdk.screensharing
-
This interface provides the
callback
and more information about theAccessControl
. - AccessControlResult - Interface in com.teamviewer.sdk.screensharing
-
Callback to provide the result of the
AccessControl
. - AccessControlRule - Enum Class in com.teamviewer.sdk.screensharing
-
Rules for access control.
- accessControlRules - Variable in class com.teamviewer.sdk.screensharing.Settings
-
A map to set the default
AccessControlRules
for the sessions. - AccessType - Enum Class in com.teamviewer.sdk.screensharing
- addFileBoxCallback(FileBoxCallback) - Method in interface com.teamviewer.sdk.screensharing.ScreenSharingSession
-
Register a
FileBoxCallback
instance that receives file box callbacks. - addMicrophoneStateCallback(MicrophoneStateCallback) - Method in interface com.teamviewer.sdk.screensharing.TeamViewerSession
- addStateChangeCallback(FileBoxItem.StateChangeCallback) - Method in interface com.teamviewer.sdk.screensharing.FileBoxItem
-
Register a
FileBoxItem.StateChangeCallback
instance that receives state changes callbacks. - addTransferProgressCallback(FileBoxItem.TransferProgressCallback) - Method in interface com.teamviewer.sdk.screensharing.FileBoxItem
-
Register a
FileBoxItem.TransferProgressCallback
instance that receives file item transfer progress callbacks. - AfterConfirmation - Enum constant in enum class com.teamviewer.sdk.screensharing.AccessControlRule
-
The access needs to be requested and confirmed first.
- Allow - Enum constant in enum class com.teamviewer.sdk.screensharing.AccessControlRule
-
The access gets automatically allowed.
- AssistARSession - Interface in com.teamviewer.sdk.screensharing
-
This interface represents a running AssistAR session.
- AuthenticationCallback - Interface in com.teamviewer.sdk.screensharing
-
Callback for authentication of incoming connections to the TeamViewer Sdk.
- AuthenticationData - Interface in com.teamviewer.sdk.screensharing
-
This interface provides the
callback
and more information about theauthentication
. - AuthenticationResult - Interface in com.teamviewer.sdk.screensharing
-
Callback to provide the result of the
authentication
. - AVAILABLE_LOCALLY - Enum constant in enum class com.teamviewer.sdk.screensharing.FileBoxItem.State
-
The item is available locally because the transfer was finished successful or it's our own item.
B
- build() - Method in class com.teamviewer.sdk.screensharing.TeamViewerSdk.Builder
-
Creates the
TeamViewerSdk
with the arguments supplied to this builder.
Must be called from the main thread. - Builder(Context) - Constructor for class com.teamviewer.sdk.screensharing.TeamViewerSdk.Builder
-
Creates a builder for the
TeamViewerSdk
.
C
- cancelDownload() - Method in interface com.teamviewer.sdk.screensharing.FileBoxItem
-
Cancels a running download.
Has no effect if called while the item is not in StateTRANSFER_IN_PROGRESS
. - com.teamviewer.sdk.screensharing - package com.teamviewer.sdk.screensharing
-
Contains interfaces and classes for interacting with the TeamViewer Screen Sharing Sdk.
- conditionalAccessRouter - Variable in class com.teamviewer.sdk.screensharing.Settings
-
Deprecated.
- conditionalAccessServers - Variable in class com.teamviewer.sdk.screensharing.Settings
-
A collection of DNS or IP addresses of Conditional Access routers you want to connect to.
Leave empty ornull
if you don't want to use this setting and let the SDK automatically resolve it.
This is the preferred setting if you want to use multiple routers. - CONNECTED - Enum constant in enum class com.teamviewer.sdk.screensharing.OnlineStateCallback.OnlineState
-
The TeamViewer Sdk is connected to the SessionCode and waiting for the Supporter to join.
- connectToSessionCode(int) - Method in class com.teamviewer.sdk.screensharing.TeamViewerSdk
-
Start connection to a given session code and wait for an incoming connection.
- connectToSessionCode(String) - Method in class com.teamviewer.sdk.screensharing.TeamViewerSdk
-
Start connection to a given session code and wait for an incoming connection.
D
- d(String, String) - Method in class com.teamviewer.sdk.screensharing.DefaultLogger
- d(String, String) - Method in interface com.teamviewer.sdk.screensharing.Logger
-
Log with debug severity.
- DefaultLogger - Class in com.teamviewer.sdk.screensharing
-
Default implementation of
Logger
which delegates all logging to Android's default log output. - DefaultLogger() - Constructor for class com.teamviewer.sdk.screensharing.DefaultLogger
- Deny - Enum constant in enum class com.teamviewer.sdk.screensharing.AccessControlRule
-
The access gets automatically denied.
- DISABLED - Enum constant in enum class com.teamviewer.sdk.screensharing.MicrophoneStateCallback.MicrophoneState
-
Microphone is disabled.
- disconnect() - Method in interface com.teamviewer.sdk.screensharing.TeamViewerSession
-
Disconnects this session and goes offline.
E
- e(String, String) - Method in class com.teamviewer.sdk.screensharing.DefaultLogger
- e(String, String) - Method in interface com.teamviewer.sdk.screensharing.Logger
-
Log with error severity.
- enableMicrophone(boolean) - Method in interface com.teamviewer.sdk.screensharing.TeamViewerSession
- ErrorCallback - Interface in com.teamviewer.sdk.screensharing
-
Callback for errors from the TeamViewer Sdk.
- ErrorCallback.ErrorCode - Enum Class in com.teamviewer.sdk.screensharing
-
Enum indicating the cause of an error.
F
- FileBoxCallback - Interface in com.teamviewer.sdk.screensharing
-
Callback for file box changes in a Teamviewer session.
- FileBoxItem - Interface in com.teamviewer.sdk.screensharing
- FileBoxItem.State - Enum Class in com.teamviewer.sdk.screensharing
- FileBoxItem.StateChangeCallback - Interface in com.teamviewer.sdk.screensharing
- FileBoxItem.TransferProgressCallback - Interface in com.teamviewer.sdk.screensharing
- FLAG_MOUSE - Static variable in interface com.teamviewer.sdk.screensharing.InputCallback
-
Flag indicating that the input is from type mouse.
- FLAG_MOUSE_BUTTON_LEFT - Static variable in interface com.teamviewer.sdk.screensharing.InputCallback
-
Flag indicating that the left mouse button is clicked.
G
- getAccessType() - Method in interface com.teamviewer.sdk.screensharing.AccessControlData
- getCallback() - Method in interface com.teamviewer.sdk.screensharing.AccessControlData
- getCallback() - Method in interface com.teamviewer.sdk.screensharing.AuthenticationData
- getFileBoxItems() - Method in interface com.teamviewer.sdk.screensharing.ScreenSharingSession
- getFileName() - Method in interface com.teamviewer.sdk.screensharing.FileBoxItem
- getFilePath() - Method in interface com.teamviewer.sdk.screensharing.FileBoxItem
- getId() - Method in interface com.teamviewer.sdk.screensharing.FileBoxItem
- getLogger() - Method in interface com.teamviewer.sdk.screensharing.TeamViewerSession
- getMicrophoneState() - Method in interface com.teamviewer.sdk.screensharing.TeamViewerSession
- getPartnerName() - Method in interface com.teamviewer.sdk.screensharing.AuthenticationData
- getRemainingTimeout() - Method in interface com.teamviewer.sdk.screensharing.AccessControlData
- getSessionId() - Method in interface com.teamviewer.sdk.screensharing.TeamViewerSession
- getSizeInBytes() - Method in interface com.teamviewer.sdk.screensharing.FileBoxItem
- getState() - Method in interface com.teamviewer.sdk.screensharing.FileBoxItem
- getStorageFolderPath() - Static method in class com.teamviewer.sdk.screensharing.TeamViewerSdk
I
- i(String, String) - Method in class com.teamviewer.sdk.screensharing.DefaultLogger
- i(String, String) - Method in interface com.teamviewer.sdk.screensharing.Logger
-
Log with info severity.
- InputCallback - Interface in com.teamviewer.sdk.screensharing
-
Callback for input of the remote supporter.
- isMicrophoneInitiallyMuted() - Method in interface com.teamviewer.sdk.screensharing.TeamViewerSession
- isOwnItem() - Method in interface com.teamviewer.sdk.screensharing.FileBoxItem
L
- Logger - Interface in com.teamviewer.sdk.screensharing
-
Callback for log messages from the TeamViewer Sdk.
M
- MicrophoneStateCallback - Interface in com.teamviewer.sdk.screensharing
-
Callback for microphone state from the TeamViewer Sdk.
- MicrophoneStateCallback.MicrophoneState - Enum Class in com.teamviewer.sdk.screensharing
-
Enum indicating the microphone state.
N
- NETWORK_ERROR - Enum constant in enum class com.teamviewer.sdk.screensharing.ErrorCallback.ErrorCode
-
Any kind of connection problem.
O
- OFF - Enum constant in enum class com.teamviewer.sdk.screensharing.MicrophoneStateCallback.MicrophoneState
-
Microphone is off.
- OFFLINE - Enum constant in enum class com.teamviewer.sdk.screensharing.OnlineStateCallback.OnlineState
-
The TeamViewer Sdk is not connected to the TeamViewer network.
- ON - Enum constant in enum class com.teamviewer.sdk.screensharing.MicrophoneStateCallback.MicrophoneState
-
Microphone is on.
- onAccessControlRequest(AccessControlData) - Method in interface com.teamviewer.sdk.screensharing.AccessControlCallback
-
Called when an access control request is received and must be authenticated.
- onAccessControlResult(boolean) - Method in interface com.teamviewer.sdk.screensharing.AccessControlResult
-
Must be called from the main thread.
- onAuthentication(AuthenticationData) - Method in interface com.teamviewer.sdk.screensharing.AuthenticationCallback
-
Called when an incoming connection request is received and must be authenticated.
- onAuthenticationCanceled() - Method in interface com.teamviewer.sdk.screensharing.AuthenticationCallback
-
Called when the authentication gets canceled before it was answered, e.g.
- onAuthenticationResult(boolean) - Method in interface com.teamviewer.sdk.screensharing.AuthenticationResult
-
Must be called from the main thread.
- onError(ErrorCallback.ErrorCode) - Method in interface com.teamviewer.sdk.screensharing.ErrorCallback
-
Called when an error occurs.
- onFileBoxItemAdded(FileBoxItem) - Method in interface com.teamviewer.sdk.screensharing.FileBoxCallback
-
Gets called when a new
FileBoxItem
was added to the file box either by us or by another participant. - onFileBoxItemRemoved(long) - Method in interface com.teamviewer.sdk.screensharing.FileBoxCallback
-
Gets called when a
FileBoxItem
was removed from the file box. - onInput(int, int, int) - Method in interface com.teamviewer.sdk.screensharing.InputCallback
-
Called when input is received from the remote supporter.
- ONLINE - Enum constant in enum class com.teamviewer.sdk.screensharing.OnlineStateCallback.OnlineState
-
The TeamViewer Sdk is successfully connected to the TeamViewer network and the token was verified.
- OnlineStateCallback - Interface in com.teamviewer.sdk.screensharing
-
Callback for online states of the TeamViewer Sdk.
- OnlineStateCallback.OnlineState - Enum Class in com.teamviewer.sdk.screensharing
-
Enum indicating the online state.
- onMicrophonePermissionGranted() - Method in interface com.teamviewer.sdk.screensharing.TeamViewerSession
- onMicrophoneStateChanged(MicrophoneStateCallback.MicrophoneState) - Method in interface com.teamviewer.sdk.screensharing.MicrophoneStateCallback
-
Called when microphone state changes.
- onOnlineStateChanged(OnlineStateCallback.OnlineState) - Method in interface com.teamviewer.sdk.screensharing.OnlineStateCallback
-
Called when online state changes.
- onProgress(int) - Method in interface com.teamviewer.sdk.screensharing.FileBoxItem.TransferProgressCallback
- onSessionEnded() - Method in interface com.teamviewer.sdk.screensharing.SessionCallback
-
Called when a TeamViewer session has ended.
- onSessionStarted(TeamViewerSession) - Method in interface com.teamviewer.sdk.screensharing.SessionCallback
-
Called when a TeamViewer session has started.
- onStateChanged(FileBoxItem.State) - Method in interface com.teamviewer.sdk.screensharing.FileBoxItem.StateChangeCallback
R
- READY_TO_DOWNLOAD - Enum constant in enum class com.teamviewer.sdk.screensharing.FileBoxItem.State
-
The item is not available locally but can be downloaded.
- registerForRequestTimedOut(Runnable) - Method in interface com.teamviewer.sdk.screensharing.AccessControlData
-
Registers a callback which triggers once the request's timeout has exceeded.
If the request has no timeout the callback will never be called. - RemoteControl - Enum constant in enum class com.teamviewer.sdk.screensharing.AccessType
-
Remote controlling the device, that is, mouse, touch and key injections.
- removeFileBoxCallback(FileBoxCallback) - Method in interface com.teamviewer.sdk.screensharing.ScreenSharingSession
-
Unregister a
FileBoxCallback
previously registered withaddFileBoxCallback()
. - removeItem() - Method in interface com.teamviewer.sdk.screensharing.FileBoxItem
-
Removes this item from the file box.
- removeMicrophoneStateCallback(MicrophoneStateCallback) - Method in interface com.teamviewer.sdk.screensharing.TeamViewerSession
- removeStateChangeCallback(FileBoxItem.StateChangeCallback) - Method in interface com.teamviewer.sdk.screensharing.FileBoxItem
-
Unregister a
FileBoxItem.StateChangeCallback
previously registered withaddStateChangeCallback()
. - removeTransferProgressCallback(FileBoxItem.TransferProgressCallback) - Method in interface com.teamviewer.sdk.screensharing.FileBoxItem
-
Unregister a
FileBoxItem.TransferProgressCallback
previously registered withaddTransferProgressCallback()
.
S
- ScreenSharingSession - Interface in com.teamviewer.sdk.screensharing
-
This interface represents a running Screen Sharing aka Remote Control session.
- SESSION_CODE_CLOSED - Enum constant in enum class com.teamviewer.sdk.screensharing.ErrorCallback.ErrorCode
-
The provided
session code
is already closed. - SESSION_CODE_EXPIRED - Enum constant in enum class com.teamviewer.sdk.screensharing.ErrorCallback.ErrorCode
-
The provided
session code
has already expired. - SESSION_CODE_INVALID - Enum constant in enum class com.teamviewer.sdk.screensharing.ErrorCallback.ErrorCode
-
The provided
session code
is invalid. - SessionCallback - Interface in com.teamviewer.sdk.screensharing
-
Callback for TeamViewer Sdk session events.
- Settings - Class in com.teamviewer.sdk.screensharing
-
Here you can define settings which changes the behaviour of the TeamViewer Sdk.
- Settings() - Constructor for class com.teamviewer.sdk.screensharing.Settings
- shareFiles(Uri...) - Method in interface com.teamviewer.sdk.screensharing.ScreenSharingSession
-
Share files with the remote supporter.
- ShareFiles - Enum constant in enum class com.teamviewer.sdk.screensharing.AccessType
-
Sharing files between the device and the remote supporter.
This rule applies to both directions.
Please note that for this access type the ruleAfterConfirmation
doesn't apply and is treated asDeny
! - SHAREFILES_CANNOT_READ_FILE - Enum constant in enum class com.teamviewer.sdk.screensharing.ErrorCallback.ErrorCode
-
At least one of the provided
files
can't be read. - SHAREFILES_FILE_TOO_LARGE - Enum constant in enum class com.teamviewer.sdk.screensharing.ErrorCallback.ErrorCode
-
At least one of the provided
files
exceeds the maximum file size limit. - SHAREFILES_NOT_ALLOWED - Enum constant in enum class com.teamviewer.sdk.screensharing.ErrorCallback.ErrorCode
-
shareFiles()
is not allowed by access control settings. - SHAREFILES_TOO_MANY_FILES - Enum constant in enum class com.teamviewer.sdk.screensharing.ErrorCallback.ErrorCode
-
shareFiles()
exceeds the maximum file limit. - shutdown() - Method in class com.teamviewer.sdk.screensharing.TeamViewerSdk
-
Leaves all sessions and goes offline.
- startDownload() - Method in interface com.teamviewer.sdk.screensharing.FileBoxItem
-
Starts downloading the item to an app-local location.
- startDownload(String) - Method in interface com.teamviewer.sdk.screensharing.FileBoxItem
-
Starts downloading the item to a given path.
Has no effect if called while the item is not in StateREADY_TO_DOWNLOAD
.
T
- TeamViewerSdk - Class in com.teamviewer.sdk.screensharing
-
Welcome to the TeamViewer Screen sharing Sdk!
- TeamViewerSdk.Builder - Class in com.teamviewer.sdk.screensharing
-
Builder object for the
TeamViewerSdk
. - TeamViewerSession - Interface in com.teamviewer.sdk.screensharing
-
This interface represents a running TeamViewer session.
- TOKEN_INVALID - Enum constant in enum class com.teamviewer.sdk.screensharing.ErrorCallback.ErrorCode
-
The provided
token
for this SDK is invalid or couldn't be checked. - TRANSFER_IN_PROGRESS - Enum constant in enum class com.teamviewer.sdk.screensharing.FileBoxItem.State
-
The item is currently downloading or uploading.
U
- useBackgroundGrabbing - Variable in class com.teamviewer.sdk.screensharing.Settings
-
Background grabbing can be enabled to speed up the grabbing process, but it may be unstable.
V
- v(String, String) - Method in class com.teamviewer.sdk.screensharing.DefaultLogger
- v(String, String) - Method in interface com.teamviewer.sdk.screensharing.Logger
-
Log with verbose severity.
- valueOf(String) - Static method in enum class com.teamviewer.sdk.screensharing.AccessControlRule
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.teamviewer.sdk.screensharing.AccessType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.teamviewer.sdk.screensharing.ErrorCallback.ErrorCode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.teamviewer.sdk.screensharing.FileBoxItem.State
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.teamviewer.sdk.screensharing.MicrophoneStateCallback.MicrophoneState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.teamviewer.sdk.screensharing.OnlineStateCallback.OnlineState
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.teamviewer.sdk.screensharing.AccessControlRule
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.teamviewer.sdk.screensharing.AccessType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.teamviewer.sdk.screensharing.ErrorCallback.ErrorCode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.teamviewer.sdk.screensharing.FileBoxItem.State
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.teamviewer.sdk.screensharing.MicrophoneStateCallback.MicrophoneState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.teamviewer.sdk.screensharing.OnlineStateCallback.OnlineState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VoIP - Enum constant in enum class com.teamviewer.sdk.screensharing.AccessType
-
VoIP call between the device and the remote supporter.
Please note that for this access type the ruleAfterConfirmation
doesn't apply and is treated asDeny
!
W
- w(String, String) - Method in class com.teamviewer.sdk.screensharing.DefaultLogger
- w(String, String) - Method in interface com.teamviewer.sdk.screensharing.Logger
-
Log with warning severity.
- withAccessControlCallback(AccessControlCallback) - Method in class com.teamviewer.sdk.screensharing.TeamViewerSdk.Builder
-
Sets a
AccessControlCallback
for listening to access control requests. - withAuthenticationCallback(AuthenticationCallback) - Method in class com.teamviewer.sdk.screensharing.TeamViewerSdk.Builder
-
Sets a
AuthenticationCallback
for listening to incoming connection requests. - withErrorCallback(ErrorCallback) - Method in class com.teamviewer.sdk.screensharing.TeamViewerSdk.Builder
-
Sets a
ErrorCallback
for listening to TeamViewer Sdk errors. - withInputCallback(InputCallback) - Method in class com.teamviewer.sdk.screensharing.TeamViewerSdk.Builder
-
Sets a
InputCallback
for listening to input from the remote supporter. - withLogger(Logger) - Method in class com.teamviewer.sdk.screensharing.TeamViewerSdk.Builder
-
Sets a
Logger callback
to which all log output from the TeamViewer Sdk is delegated to. - withMicInitiallyMuted(boolean) - Method in class com.teamviewer.sdk.screensharing.TeamViewerSdk.Builder
-
Sets the initial microphone state for the session.
- withOnlineStateCallback(OnlineStateCallback) - Method in class com.teamviewer.sdk.screensharing.TeamViewerSdk.Builder
-
Sets a
OnlineStateCallback
for listening to online state changes. - withSessionCallback(SessionCallback) - Method in class com.teamviewer.sdk.screensharing.TeamViewerSdk.Builder
-
Sets a
SessionCallback
for listening to TeamViewer session events. - withSettings(Settings) - Method in class com.teamviewer.sdk.screensharing.TeamViewerSdk.Builder
-
Sets
Settings
which changes the behaviour of the TeamViewer Sdk. - withStorageFolder(String) - Method in class com.teamviewer.sdk.screensharing.TeamViewerSdk.Builder
-
Sets the root path for file transfer Assist AR.
- withToken(String) - Method in class com.teamviewer.sdk.screensharing.TeamViewerSdk.Builder
-
Sets the Sdk token which is mandatory to use the TeamViewer Sdk.
All Classes and Interfaces|All Packages|Constant Field Values
Settings.conditionalAccessServers
instead