FLBookmarksFactory Enumeration Reference


                    
                    
                    bookmarkSessionConfiguration(endPoint:bookmarkSyncInterval:bookmarkThresholdPercentage:thresholdPlaybackPositionMs:)

API to construct BookmarkSessionConfiguration confirmed value type instance

Declaration

Swift

public static func bookmarkSessionConfiguration(endPoint: String,
                                                bookmarkSyncInterval: TimeInterval = 60000, bookmarkThresholdPercentage: Double? = 0.95, thresholdPlaybackPositionMs: TimeInterval? = nil) -> BookmarkSessionConfiguration

Parameters

`endPoint`	The server url for bookmark service
`bookmarkSyncInterval`	Sync interval time for Bookmark Service in millisecs. Default value is 60000ms.
`bookmarkThresholdPercentage`	Threshold percentage value for bookmark service.Default value is 0.95.
`thresholdPlaybackPositionMs`	Playback position in millisecs, beyond which content is considered fully watched.


                    
                    
                    bookmarkService(endPoint:httpClient:authorizer:)

API to construct BookmarkService confirmed reference type instance.

Declaration

Swift

public static func bookmarkService(endPoint: String, httpClient: HTTPClient = FLFoundationFactory.httpClient(), authorizer: PlatformAuthorizer) -> BookmarkService

Parameters

`endPoint`	The server url for bookmark service
`httpClient`	The `HTTPClient` for performing URL load requests
`authorizer`	PlatformAuthorizer for creating authorized network request.Check `PlatformAuthorizer`for further details


                    
                    
                    bookmarksManager(configuration:itemId:seasonId:episodeId:videoId:mode:seasonNumber:episodeNumber:contentType:bookmarkService:authorizer:)

API to construct BookmarksManager confirmed reference type instance.

Declaration

Swift

@available(*, deprecated, message: "This API has been deprecated. Please use `bookmarksManager(configuration: bookmarkAttributes: bookmarkService:﹚` or `bookmarksManager(configuration: bookmarkAttributes: authorizer: httpClient:﹚` instead.")
public static func bookmarksManager(configuration: BookmarkSessionConfiguration, itemId: String, seasonId: String? = nil, episodeId: String? = nil, videoId: String? = nil, mode: Mode? = nil, seasonNumber: Int? = nil, episodeNumber: Int? = nil, contentType: String? = nil, bookmarkService: BookmarkService, authorizer _: PlatformAuthorizer? = nil) -> BookmarksManager

Parameters

`configuration`	The configuration for the bookmarks manager. Check `BookmarkSessionConfiguration` for further details.
`itemId`	Unique identifier of the content
`seasonId`	season identifier of the content
`episodeId`	episode identifier of the content
`videoId`	video identifier of the content
`mode`	Indicates the type of content (series, episode or playlist).
`seasonNumber`	current season number of the content
`episodeNumber`	current episode number of the content
`bookmarkService`	BookmarkService as optional param
`authorizer`	PlatformAuthorizer for creating authorized network request.Check `PlatformAuthorizer`for further details
`contentType`	The content type of the content


                    
                    
                    bookmarksManager(configuration:bookmarkAttributes:bookmarkService:nextItem:)

API to construct BookmarksManager confirmed reference type instance.

Declaration

Swift

public static func bookmarksManager(configuration: BookmarkSessionConfiguration, bookmarkAttributes: BookmarkAttributes, bookmarkService: BookmarkService, nextItem: BookmarkAttributes? = nil) -> BookmarksManager

Parameters

`configuration`	The configuration for the bookmarks manager. Check `BookmarkSessionConfiguration` for further details.
`bookmarkAttributes`	The bookmark request attributes
`bookmarkService`	BookmarkService as optional param
`nextItem`	(Optional) Bookmark attributes for the next item. If provided, when the current items end threshold is reached, this item be added to bookmark record with offset 0.


                    
                    
                    bookmarksManager(configuration:bookmarkAttributes:authorizer:httpClient:nextItem:)

API to construct BookmarksManager confirmed reference type instance.

Declaration

Swift

public static func bookmarksManager(configuration: BookmarkSessionConfiguration, bookmarkAttributes: BookmarkAttributes, authorizer: PlatformAuthorizer, httpClient: HTTPClient = FLFoundationFactory.httpClient(), nextItem: BookmarkAttributes? = nil) -> BookmarksManager

Parameters

`configuration`	The configuration for the bookmarks manager. Check `BookmarkSessionConfiguration` for further details.
`bookmarkAttributes`	The bookmark request attributes
`authorizer`	PlatformAuthorizer for creating authorized network request.Check `PlatformAuthorizer`for further details
`httpClient`	The `HTTPClient` for performing URL load requests
`nextItem`	(Optional) Bookmark attributes for the next item. If provided, when the current items end threshold is reached, this item be added to bookmark record with offset 0.


                    
                    
                    bookmarksManager(configuration:bookmarkAttributes:authorizer:configurationCallback:httpClient:)

API to construct QueueBookmarksManager for queue-based playback with PlatformAuthorizer.

Declaration

Swift

public static func bookmarksManager(
    configuration: BookmarkSessionConfiguration,
    bookmarkAttributes: BookmarkAttributes,
    authorizer: PlatformAuthorizer,
    configurationCallback: MediaPlaylistItemTransitionCallback,
    httpClient: HTTPClient = FLFoundationFactory.httpClient()
) -> BookmarksManager

Parameters

`configuration`	The configuration for the bookmarks manager
`bookmarkAttributes`	The bookmark request attributes
`authorizer`	PlatformAuthorizer for creating authorized network requests
`configurationProvider`	Provider to supply bookmark configuration for each media item
`httpClient`	The HTTPClient for performing URL load requests


                    
                    
                    bookmarksManager(configuration:bookmarkAttributes:bookmarkService:configurationCallback:)

API to construct QueueBookmarksManager for queue-based playback with custom BookmarkService.

Declaration

Swift

public static func bookmarksManager(
    configuration: BookmarkSessionConfiguration,
    bookmarkAttributes: BookmarkAttributes,
    bookmarkService: BookmarkService,
    configurationCallback: MediaPlaylistItemTransitionCallback
) -> BookmarksManager

Parameters

`configuration`	The configuration for the bookmarks manager
`bookmarkAttributes`	The bookmark request attributes
`bookmarkService`	Custom BookmarkService instance
`configurationProvider`	Provider to supply bookmark configuration for each media item