SDK State Update Reciever Interface. More...

Inheritance diagram for ISdkStateReceiver:

Public Member Functions
default void	OnLoginError (ErrorType errorType, @Nullable String message)
	Error when logging in.

default void	OnActivationCode (ErrorType errorType, @Nullable String message, @NonNull String activationCode, @NonNull String activationUrl)
	Activation code result.

default void	OnConnectError (ErrorType errorType, @Nullable String message)
	Error when connecting to a server.

default void	OnState (State state)
	State update received.

default void	OnConnectedServer (@Nullable ServerInformation serverInfo)
	Connected update received.

default void	OnAdaptersList (@NonNull List< AdapterData > adapters)
	Network adapters list update received.

default void	OnDirectory (@NonNull List< ServerInformation > servers)
	Directory update received This list can be refreshed with `refreshDirectory`.

default void	OnConnectionStats (@NonNull ConnectionStatsGroup tunnelStats)
	Latest tunnel stats update.

default void	OnConnectionStats (@NonNull List< ConnectionStatsGroup > tunnelStats)
	Historic tunnel stats update.

default void	OnSessionStats (@NonNull SessionStatPeriods stats)
	Session stats update.

default void	OnStreamingStats (StreamingStats stats)
	Streaming stats update.

default void	OnNewAdapter (@NonNull String adapterID, NetworkType type)
	Notification for the first time seeing a new adapter.

default void	OnAdapterOverlimit (@NonNull String adapterID, NetworkType type, @NonNull AdapterUsageData usageData)
	Notification when an adapter is near its daily or monthly data usage limit.

default void	OnSettings (@NonNull Settings settings)
	Notification on settings change.

default void	OnAccountingData (@NonNull AccountingData accounting)
	Accounting data update This can be refreshed with `refreshAccounting`.

default void	OnPrivacySettings (@NonNull PrivacySettings privacy)
	Privacy settings update This can be refreshed with `refreshPrivacy`.

default void	OnDirectorySettings (@NonNull DirectorySettings directorySettings)
	Directory settings update This can be refreshed with `refreshDirectorySettings`.

default void	OnAccountCheckResult (ErrorType errorType, @Nullable String errorMessage, boolean accountExists)
	Account check result.

default void	OnAccountCreateResult (ErrorType errorType, @Nullable String errorMessage)
	Account create result.

default void	OnPasswordChangeResult (ErrorType errorType, @Nullable String errorMessage)
	Password change result.

default void	OnTorrentDetection (boolean willDisconnect)
	A torrent use was detected.

default void	OnNonVPNApplications (@NonNull List< String > nonVpnApps)
	List of apps configured to go around the VPN.

default void	OnSettingError (@NonNull String settingAction, ErrorType errorType, @Nullable String message)
	Called in response to an error changing a setting.

default void	OnLocalVendorSettings (@Nullable JSONObject settings)
	Local vendor settings update.

default void	OnRemoteVendorSettings (@Nullable JSONObject settings)
	Remote vendor settings update.

default void	OnVendorUserData (@Nullable String userData)
	Vendor user data update.

default void	OnLocalProxySettings (@NonNull LocalProxySettings settings)
	Local proxy settings update.

default void	OnFirewallSettings (@NonNull FirewallSettings settings)
	Firewall settings update.

default void	OnStreamingSettings (@NonNull StreamingSettings settings)
	Streaming settings update.

default void	OnLocalProxyDomainWatchlistHit (@Nullable String title)
	Called when a domain from a disabled localproxy domainwatchlist is detected.

default void	OnCaptivePortals (@NonNull List< String > networks)
	Called when captive portals are detected.

default void	OnServerSettings (@NonNull ServerSettings settings)
	Server settings update.

default void	OnVPNPermissionResult (boolean hasPermission)
	Result of request for VPN permission.

default void	OnLastDisconnectEvent (@NonNull DisconnectEvent lastDisconnectEvent)
	Result of request for the last disconnect event.

default void	OnLogSettings (@NonNull DaemonLogSettings daemon)
	Log settings result.

default void	OnSpeedTestResults (@NonNull List< SpeedTestResultData > results)
	Speed test result data.

default void	OnLogReportResult (ErrorType errorType, @Nullable String message, @Nullable String ticketId)
	Result of a log report request.

Public Member Functions inherited from INetworkSharingReceiver
default void	OnNetworkSharingSettings (NetworkSharing.Settings settings)
	Network sharing settings.

default void	OnNetworkSharingDiscovery (boolean discoveryActive)
	Network sharing discovery state.

default void	OnNetworkSharesAvailable (List< NetworkSharing.Peer > availableShares)
	Available network shares.

default void	OnNetworkSharingPeerStatusChange (NetworkSharing.PeerRole role, NetworkSharing.PeerUuid uuid, NetworkSharing.PeerStatus peerStatus, NetworkSharing.TunnelStatus tunnelStatus, ErrorType errorType, String errorMessage)
	state changes and connection errors with peers

default void	OnNetworkSharingPairRequest (NetworkSharing.PeerUuid uuid, String displayName)
	Event when a peer requests a pairing.

default void	OnNetworkSharingNewPeerAvailable (NetworkSharing.PeerUuid uuid, String displayName)
	Event when a new peer is available.

Detailed Description

SDK State Update Reciever Interface.

These calls only happen on the main process by default. All calls are sent from background threads. As of 11.1, EnableSDKHandlerFromBackground enables these to also be delivered to the background process.

Since: 11.9.2

Member Function Documentation

◆ OnAccountCheckResult()

default void OnAccountCheckResult	(	ErrorType	errorType,
		@Nullable String	errorMessage,
		boolean	accountExists )

Account check result.

Parameters

errorType	type of the error
errorMessage	message
accountExists	if not an error, if the account exists

Since: 7.5

Deprecated: as of 15.4. Functionality removed

◆ OnAccountCreateResult()

default void OnAccountCreateResult	(	ErrorType	errorType,
		@Nullable String	errorMessage )

Account create result.

Parameters

errorType	type of the error
errorMessage	message

Since: 7.5

Deprecated: as of 15.4. Functionality removed

◆ OnAccountingData()

default void OnAccountingData ( @NonNull AccountingData accounting )

Accounting data update This can be refreshed with refreshAccounting.

Parameters

accounting information on the current account

Since: 6.1

◆ OnActivationCode()

default void OnActivationCode	(	ErrorType	errorType,
		@Nullable String	message,
		@NonNull String	activationCode,
		@NonNull String	activationUrl )

Activation code result.

Parameters

errorType	type of error
message	error message
activationCode	activation code
activationUrl	activation url

Since: 14.0

◆ OnAdapterOverlimit()

default void OnAdapterOverlimit	(	@NonNull String	adapterID,
		NetworkType	type,
		@NonNull AdapterUsageData	usageData )

Notification when an adapter is near its daily or monthly data usage limit.

This is called at 75% and 100% usage. You must call handleAdapterOverlimit on SpeedifySDK to clear this message. SpeedifyHandler's default implemenation does this automatically.

Parameters

adapterID	ID of the adapter
type	type of the adapter
usageData	information on current usage of the adapter

Since: 5.8

Implemented in SpeedifyHandler.

◆ OnAdaptersList()

default void OnAdaptersList ( @NonNull List< AdapterData > adapters )

Network adapters list update received.

Sent on changes and every 30s while connected to update usage data.

Parameters

adapters list of adapters

Since: 5.8

◆ OnCaptivePortals()

default void OnCaptivePortals ( @NonNull List< String > networks )

Called when captive portals are detected.

Parameters

networks networks on which a captive portal was detected

Since: 9.3

◆ OnConnectedServer()

default void OnConnectedServer ( @Nullable ServerInformation serverInfo )

Connected update received.

Send on start of connection attempt and connection completion.

Parameters

serverInfo currently connected server

Since: 5.6

◆ OnConnectError()

default void OnConnectError	(	ErrorType	errorType,
		@Nullable String	message )

Error when connecting to a server.

Parameters

errorType	type of error
message	error message

Since: 5.6

◆ OnConnectionStats() [1/2]

default void OnConnectionStats ( @NonNull ConnectionStatsGroup tunnelStats )

Latest tunnel stats update.

Sent once per second while connected, if tunnel stat updates are enabled. via enableStatUpdates.

Parameters

tunnelStats a group of tunnelstats for a point in time

Since: 5.8

◆ OnConnectionStats() [2/2]

default void OnConnectionStats ( @NonNull List< ConnectionStatsGroup > tunnelStats )

Historic tunnel stats update.

Parameters

tunnelStats list of tunnelstats for a period of time

Since: 5.8

◆ OnDirectory()

default void OnDirectory ( @NonNull List< ServerInformation > servers )

Directory update received This list can be refreshed with refreshDirectory.

Parameters

servers list of servers

Since: 5.6

◆ OnDirectorySettings()

default void OnDirectorySettings ( @NonNull DirectorySettings directorySettings )

Directory settings update This can be refreshed with refreshDirectorySettings.

Parameters

directorySettings directory settings

Since: 10.5

◆ OnFirewallSettings()

default void OnFirewallSettings ( @NonNull FirewallSettings settings )

Firewall settings update.

Parameters

settings current firewall settings

Since: 9.2

◆ OnLastDisconnectEvent()

default void OnLastDisconnectEvent ( @NonNull DisconnectEvent lastDisconnectEvent )

Result of request for the last disconnect event.

Parameters

lastDisconnectEvent the last disconnect event

Since: 10.4

◆ OnLocalProxyDomainWatchlistHit()

default void OnLocalProxyDomainWatchlistHit ( @Nullable String title )

Called when a domain from a disabled localproxy domainwatchlist is detected.

Parameters

title title of the watchlist that was detected

Since: 9.3

◆ OnLocalProxySettings()

default void OnLocalProxySettings ( @NonNull LocalProxySettings settings )

Local proxy settings update.

Parameters

settings current local proxy settings

Since: 9.2

◆ OnLocalVendorSettings()

default void OnLocalVendorSettings ( @Nullable JSONObject settings )

Local vendor settings update.

Parameters

settings current local vendor settings

Since: 9.2

◆ OnLoginError()

default void OnLoginError	(	ErrorType	errorType,
		@Nullable String	message )

Error when logging in.

Parameters

errorType	type of error
message	error message

Since: 5.6

◆ OnLogReportResult()

default void OnLogReportResult	(	ErrorType	errorType,
		@Nullable String	message,
		@Nullable String	ticketId )

Result of a log report request.

Parameters

errorType	type of error
message	error message
ticketId	ticket id

Since: 14.8.6

◆ OnLogSettings()

default void OnLogSettings ( @NonNull DaemonLogSettings daemon )

Log settings result.

Parameters

daemon log settings

Since: 10.5

◆ OnNewAdapter()

default void OnNewAdapter	(	@NonNull String	adapterID,
		NetworkType	type )

Notification for the first time seeing a new adapter.

You must call handleNewAdapter on SpeedifySDK to clear this message. SpeedifyHandler's default implemenation does this automatically.

Parameters

adapterID	ID of the adapter
type	type of the adapter

Since: 7.3

Implemented in SpeedifyHandler.

◆ OnNonVPNApplications()

default void OnNonVPNApplications ( @NonNull List< String > nonVpnApps )

List of apps configured to go around the VPN.

Parameters

nonVpnApps app package ids

Since: 7.6.1

◆ OnPasswordChangeResult()

default void OnPasswordChangeResult	(	ErrorType	errorType,
		@Nullable String	errorMessage )

Password change result.

Parameters

errorType	type of the error
errorMessage	message

Since: 7.5

Deprecated: as of 15.4. Functionality removed

◆ OnPrivacySettings()

default void OnPrivacySettings ( @NonNull PrivacySettings privacy )

Privacy settings update This can be refreshed with refreshPrivacy.

Parameters

privacy privacy settings

Since: 6.3

◆ OnRemoteVendorSettings()

default void OnRemoteVendorSettings ( @Nullable JSONObject settings )

Remote vendor settings update.

Parameters

settings current remote vendor settings

Since: 9.2

◆ OnServerSettings()

default void OnServerSettings ( @NonNull ServerSettings settings )

Server settings update.

Parameters

settings current server settings

Since: 9.4

◆ OnSessionStats()

default void OnSessionStats ( @NonNull SessionStatPeriods stats )

Session stats update.

Parameters

stats session stat periods object

Since: 9.5

◆ OnSettingError()

default void OnSettingError	(	@NonNull String	settingAction,
		ErrorType	errorType,
		@Nullable String	message )

Called in response to an error changing a setting.

Parameters

settingAction	string identifying the setting that failed to change
errorType	type of error
message	error message

Since: 14.0

Implemented in SpeedifyHandler.

◆ OnSettings()

default void OnSettings ( @NonNull Settings settings )

Notification on settings change.

Parameters

settings the current settings

Since: 5.8

◆ OnSpeedTestResults()

default void OnSpeedTestResults ( @NonNull List< SpeedTestResultData > results )

Speed test result data.

Parameters

results list of speed test results

Since: 11.0

◆ OnState()

default void OnState ( State state )

State update received.

This is sent on state updates, and every 30s while connected.

Parameters

state current state

Since: 5.6

◆ OnStreamingSettings()

default void OnStreamingSettings ( @NonNull StreamingSettings settings )

Streaming settings update.

Parameters

settings current streaming settings

Since: 10.9

◆ OnStreamingStats()

default void OnStreamingStats ( StreamingStats stats )

Streaming stats update.

Parameters

stats streaming stats object

Since: 9.6

◆ OnTorrentDetection()

default void OnTorrentDetection ( boolean willDisconnect )

A torrent use was detected.

Parameters

willDisconnect if this use will trigger a disconnect

Since: 7.5

◆ OnVendorUserData()

default void OnVendorUserData ( @Nullable String userData )

Vendor user data update.

Parameters

userData current vendor user data

Since: 9.8

◆ OnVPNPermissionResult()

default void OnVPNPermissionResult ( boolean hasPermission )

Result of request for VPN permission.

Parameters

hasPermission whether permission was obtained

Since: 10.0

The documentation for this interface was generated from the following file:

speedifysdk/src/main/java/com/speedify/speedifysdk/receivers/ISdkStateReceiver.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ OnAccountCheckResult()

◆ OnAccountCreateResult()

◆ OnAccountingData()

◆ OnActivationCode()

◆ OnAdapterOverlimit()

◆ OnAdaptersList()

◆ OnCaptivePortals()

◆ OnConnectedServer()

◆ OnConnectError()

◆ OnConnectionStats() [1/2]

◆ OnConnectionStats() [2/2]

◆ OnDirectory()

◆ OnDirectorySettings()

◆ OnFirewallSettings()

◆ OnLastDisconnectEvent()

◆ OnLocalProxyDomainWatchlistHit()

◆ OnLocalProxySettings()

◆ OnLocalVendorSettings()

◆ OnLoginError()

◆ OnLogReportResult()

◆ OnLogSettings()

◆ OnNewAdapter()

◆ OnNonVPNApplications()

◆ OnPasswordChangeResult()

◆ OnPrivacySettings()

◆ OnRemoteVendorSettings()

◆ OnServerSettings()

◆ OnSessionStats()

◆ OnSettingError()

◆ OnSettings()

◆ OnSpeedTestResults()

◆ OnState()

◆ OnStreamingSettings()

◆ OnStreamingStats()

◆ OnTorrentDetection()

◆ OnVendorUserData()

◆ OnVPNPermissionResult()