Younify Connect SDK/tv.younify.sdk.connect

Package-level declarations

This package contains the Younify Connect SDK main objects and types.

Types

Younify Connect SDK main object.

data class ConnectOptions(var key: String?, var logLevel: LogLevel = LogLevel.Warning, var logListener: LogListener?, var tokenHandler: TokenHandler?, var accessToken: String?, var refreshToken: String?, var extra: Map<String, Any>?)

Younify Connect SDK startup options.

Error

enum Error : Enum<Error>

SDK Error Codes.

FetchContentAllCategoriesCompleteCallback

typealias FetchContentAllCategoriesCompleteCallback = (results: List<FetchContentCategoryResult>, error: Throwable?) -> Unit

Connect.fetchContent callback for when all categories have loaded for all streaming services.

FetchContentAsyncAllCategoriesCompleteCallback

@FunctionalInterface

fun interface FetchContentAsyncAllCategoriesCompleteCallback

Java functional interface for a Connect.fetchContentAsync callback that is called when all categories have loaded for all streaming services.

FetchContentAsyncCategoryServiceCompleteCallback

@FunctionalInterface

fun interface FetchContentAsyncCategoryServiceCompleteCallback

Java functional interface for a Connect.fetchContentAsync callback that is called when a category has loaded for a streaming service.

FetchContentAsyncServiceErrorCallback

@FunctionalInterface

fun interface FetchContentAsyncServiceErrorCallback

Java functional interface for a Connect.fetchContentAsync callback that is called when a problem occurs accessing a streaming service.

FetchContentCategoryResult

data class FetchContentCategoryResult(val category: StreamingCategory, val services: List<FetchContentCategoryServiceResult> = mutableListOf()) : Parcelable

Fetch content category result.

FetchContentCategoryServiceCompleteCallback

typealias FetchContentCategoryServiceCompleteCallback = (category: StreamingCategory, service: StreamingService, content: List<StreamingContent>, error: Throwable?) -> Unit

Connect.fetchContent callback for when a category has loaded for a streaming service.

FetchContentCategoryServiceResult

data class FetchContentCategoryServiceResult(val service: StreamingService, val content: List<StreamingContent> = mutableListOf()) : Parcelable

Fetch content category service result.

FetchContentServiceErrorCallback

typealias FetchContentServiceErrorCallback = (service: StreamingService, error: Throwable?) -> Unit

Connect.fetchContent callback for when a problem occurs accessing a streaming service.

GenericException

interface GenericException

A generic exception interface that all sdk exception classes implement.

GenericExceptionUserInfoKeys

object GenericExceptionUserInfoKeys

Collection of keys supported by GenericException.userInfo.

InvalidArgumentException

class InvalidArgumentException(val paramName: String) : GenericExceptionImpl

An invalid argument was encountered.

InvalidViewContextException

class InvalidViewContextException : GenericExceptionImpl

This view context is invalid.

LogLevel

enum LogLevel : Enum<LogLevel>

Log level.

LogListener

interface LogListener

Optionally implement this interface to receive log events from the sdk. The instance can be set in ConnectOptions.

NetworkRequestFailedException

class NetworkRequestFailedException(val statusCode: Int) : GenericExceptionImpl

A network error occurred. The user is either offline or the server returned an invalid response.

OperationCanceledException

class OperationCanceledException(val partialResult: Any?) : GenericException

The requested operation has been canceled.

RenewTokensCallback

@FunctionalInterface

fun interface RenewTokensCallback

Callback that must be called when tokens have been renewed.

SDKVersionNotSupportedException

class SDKVersionNotSupportedException : GenericExceptionImpl

The current version of the SDK is no longer supported.

SearchContentAllCompleteCallback

typealias SearchContentAllCompleteCallback = (results: List<SearchContentServiceResult>, error: Throwable?) -> Unit

Connect.searchContent callback for when all streaming services have been searched.

SearchContentAsyncAllCompleteCallback

@FunctionalInterface

fun interface SearchContentAsyncAllCompleteCallback

Java functional interface for a Connect.searchContentAsync callback that is called when all streaming services have been searched.

SearchContentAsyncServiceCompleteCallback

@FunctionalInterface

fun interface SearchContentAsyncServiceCompleteCallback

Java functional interface for a Connect.searchContentAsync callback that is called when a streaming service search has completed.

SearchContentServiceCompleteCallback

typealias SearchContentServiceCompleteCallback = (service: StreamingService, content: List<StreamingContent>, error: Throwable?) -> Unit

Connect.searchContent callback for when a streaming service search has completed.

SearchContentServiceResult

data class SearchContentServiceResult(val service: StreamingService, val content: List<StreamingContent> = mutableListOf()) : Parcelable

Search content service result.

ServiceContentNotFoundException

class ServiceContentNotFoundException : GenericExceptionImpl

This service content may no longer be available.

ServiceFetchingFailedException

class ServiceFetchingFailedException : GenericExceptionImpl

The service fetch operation failed.

ServiceLinkingFailedException

class ServiceLinkingFailedException(serviceMessage: String?) : GenericExceptionImpl

The service linking operation failed.

ServiceLoginFailedException

class ServiceLoginFailedException : GenericExceptionImpl

The service login failed. The user should verify their login information.

ServiceProfileNotFoundException

class ServiceProfileNotFoundException : GenericExceptionImpl

The service profile was not found. The user should select another profile.

ServiceProfilePinMismatchException

class ServiceProfilePinMismatchException : GenericExceptionImpl

The service profile pin was not correct. The user should enter their pin again.

ServiceTemporarilyUnavailableException

class ServiceTemporarilyUnavailableException : GenericExceptionImpl

The service is temporarily unavailable.

ServiceUnsupportedException

class ServiceUnsupportedException : GenericExceptionImpl

The service is not supported by the SDK.

StreamingCategories

object StreamingCategories

Well-known streaming service categories.

StreamingCategory

data class StreamingCategory(var name: String) : Parcelable

Streaming service content category.

StreamingContent

data class StreamingContent(var type: StreamingContentType, var name: String, var title: String, var overview: String?, var duration: Long, var airDate: Instant?, var smallThumbnailUrl: String?, var largeThumbnailUrl: String?, var itemID: String?, var series: String?, var season: String?, var episode: String?, var releaseYear: String?, var contentRating: String?, var watchNowUrl: String?, var tmdbID: String?, var tmdbSeriesID: String?, var path: List<String>) : Parcelable

Streaming service content.

StreamingContentDetails

data class StreamingContentDetails(var estimatedDuration: Long?) : Parcelable

Streaming service content details.

StreamingContentType

enum StreamingContentType : Enum<StreamingContentType>

Streaming service content type.

StreamingService

data class StreamingService(var id: String, var name: String, var smallThumbnailUrl: String?, var largeThumbnailUrl: String?, var overlayThumbnailUrl: String?, var isAvailable: Boolean, var link: StreamingServiceLink?) : Parcelable

Streaming service.

StreamingServiceLink

data class StreamingServiceLink(var username: String?, var profileName: String?, var profileImageUrl: String?, var isProfilePINProtected: Boolean, var isBroken: Boolean) : Parcelable

Streaming service link.

SystemMaintenanceException

class SystemMaintenanceException : GenericExceptionImpl

The system is currently down for maintenance.

TokenHandler

interface TokenHandler

Token handler.

UnknownException

class UnknownException : GenericExceptionImpl

An unknown error occurred.

UserConsentRequiredException

class UserConsentRequiredException : GenericExceptionImpl

The user tried to perform an action that requires privacy policy consent.