nonewill prevent the session data and media from syncing. The session will not appear in
basicwill allow base session information (e.g. name, properties, creation date) to sync, but will prevent session data from syncing. The session will appear in
skylight.sessions, but without session data.
allwill allow all session information and session data for the session to sync. The session will appear in
skylight.sessionswith session data.
nonewill prevent all media metadata and content from syncing for the session.
session.mediawill be undefined or an empty list.
metadatawill allow media metadata to sync for the session, but will prevent media content from syncing.
session.mediawill contain a list of media items with metadata populated for each item. While
mediaIdwill be available, binding to or otherwise trying to access the media content will fail.
allwill allow media metadata and content to sync for the session.
session.mediawill contain a list of media items and
mediaIdcan be used in media databindings to display the media content.
inherit) will automatically use the remote sync mode.
skylight.session.setSessionSyncModeand can be accessed in
session.sync.mode. The local sync modes can be set using
skylight.session.setLocalSessionSyncModeand are accessible in
session.local.sync.mode. For more details on using these methods and properties from the scripting API, see Scripting API Reference.
inheritvalue, which mean that the remote sync modes are used. If the local sync modes are updated to be non-
inherit, setting them back to
inheritwill restore this default behavior of using the remote sync mode.
session.local.sync.status. This can be one of two string values:
in-progressif data or media for that session is still being synchronized for that device.
completedif all data and media for that session have completed synchronizing.
skylight.getSessions(see Scripting API Reference for details) to retrieve basic session information for any sessions that are visible to the user that match the query criteria. This is useful for retrieving information about sessions that may be otherwise inaccessible, such as those that are not synced (ie, data sync mode set to
none) or those that are closed.
getSessionsonly contain basic information about the session (e.g. session name, creator, time created, properties) and will not include session data or session media even if the session is currently synchronized to the device.
getSessionsis a snapshot of the matching sessions as they appeared at the time of query. As such, any updates to those sessions (e.g. adding a new property or changing the name of the session) will not be reflected in the session object returned in the list from
getSessions. This is notably different from the sessions in
skylight.sessions, which are the sessions that are explicitly synchronized and will be kept updated with changes.
nonefor both data and media after creating it. If the user who created the session requires the session to be synchronized to perform further work on it, the local session sync mode should then be set to
allfor both data and media, which will then synchronize the session data and media for the user.
inheritfor both data and media. Or, the session will be unset the next time the user signs out.
getSessions. The returned list is then stored in
skylight.local.saveData. The property used to store this can be databound, which will then automatically update when the value is set to the returned array.
getSessionscall as described above, a list of cards can be shown, each having a session returned from
getSessionsas a context. By using the select action for the card to update the local sync mode, we can sync the appropriate session when the user selects the card.
allfor both data and media. Then, the session data and media will begin to sync. At this point, the session can be set using
skylight.session.setand a view/card bound to the session can be shown to the user which will begin to populate with the information being synchronized for the session.