ASFService API

Callback method invoked when a ServiceProvider object is successfully created.

void onsuccess(ServiceProvider serviceProvider);

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/allshare

Parameters :

• serviceProvider : Created ServiceProvider object

Code Example :

// onsuccess sProviderCallback
function sProviderCallback(provider) {
  
  console.log("The service provider was obtained");
}

// Define the ServiceProvider creation error callback
function eProviderCallback(error, state) {
  
  console.log(error.name);
  console.log("Current ASF service state: " + state);
  
}

// Try to create the ServiceProvider object
try {
  webapis.allshare.serviceconnector.createServiceProvider(sProviderCallback, eProviderCallback);
}
catch(e) {
  console.log(e.message);
}

Callback method invoked if a ServiceProvider operation fails.

void onerror(WebAPIError error, ServiceState state);

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/allshare

Parameters :

• error : Object indicating the error type and message
• state : Current service state

Code Example :

// onerror eProviderCallback
function sProviderCallback(provider) {
  
  console.log("The service provider was obtained");
}

// Define the ServiceProvider creation error callback
function eProviderCallback(error, state) {
  
  console.log(error.name);
  console.log("Current ASF service state: " + state);
  
}

// Try to create the ServiceProvider object
try {
  webapis.allshare.serviceconnector.createServiceProvider(sProviderCallback, eProviderCallback);
}
catch(e) {
  console.log(e.message);
}

Creates a ServiceProvider object.

void createServiceProvider(optional ServiceProviderCreateSuccessCallback? successCallback, optional ServiceProviderErrorCallback? errorCallback);

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/allshare

Parameters :

• successCallback [optional][nullable] : Callback method to invoke if the request is successful
• errorCallback [optional][nullable] : Callback method to invoke if the request fails

Exceptions :

• WebAPIException
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type.
  • with error type NotSupportedError, if this feature is not supported.
  • with error type InvalidValuesError, if any input parameter contains an invalid value.
  • with error type UnknownError, for any other error.
  • with error type SecurityError, if the application does not have the privilege to call this method.

Since : 2.3

Code Example :

// Define the ServiceProvider creation success callback
function sProviderCallback(provider) {
  
  console.log("The service provider was obtained");
}

// Define the ServiceProvider creation error callback
function eProviderCallback(error, state) {
  
  console.log(error.name);
  console.log("Current ASF service state: " + state);
  
}

// Try to create the ServiceProvider object
try {
  webapis.allshare.serviceconnector.createServiceProvider(sProviderCallback, eProviderCallback);
}
catch(e) {
  console.log(e.message);
}

Deletes a ServiceProvider object.

void deleteServiceProvider(optional SuccessCallback? successCallback, optional ServiceProviderErrorCallback? errorCallback);

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/allshare

Parameters :

• successCallback [optional][nullable] : Callback method to invoke if the request is successful
• errorCallback [optional][nullable] : Callback method to invoke if the request fails

Exceptions :

• WebAPIException
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type.
  • with error type NotSupportedError, if this feature is not supported.
  • with error type InvalidValuesError, if any input parameter contains an invalid value.
  • with error type UnknownError, for any other error.

Since : 2.3

Code Example :

// You must already have a ServiceProvider object
var serviceProvider;

// Define the ServiceProvider deletion success callback
function sProviderDeleteCallback() {
  
  console.log("The ASF service provider has been deleted properly.");
}

// Define the ServiceProvider deletion error callback
function eProviderDeleteCallback(error, state) {
  
  console.log(error.name);
  console.log("The current ASF service state: " + state);
  
}

// Try to delete the ServiceProvider object
try {
  webapis.allshare.serviceconnector.deleteServiceProvider(sProviderDeleteCallback, eProviderDeleteCallback);
}
catch(e) {
  console.log(e.message);
}

Returns a ServiceProvider object that is connected to the AllShare Framework.

ServiceProvider getServiceProvider();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/allshare

Return Value :

• ServiceProvider : ServiceProvider ServiceProvider object connected to the AllShare Framework

Exceptions :

• WebAPIException
  • with error type NotSupportedError, if this feature is not supported.
  • with error type UnknownError, for any other error.

Since : 2.3

Code Example :

try {
  // You must already have a ServiceProvider object
  var serviceProvider = webapis.allshare.serviceconnector.getServiceProvider();
  if (serviceProvider == null) {
    console.log("Service provider was not created properly");
  }
}
catch(e) {
  console.log(e.message);
}

Returns the DeviceFinder object used to find AllShare devices.

DeviceFinder getDeviceFinder();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/allshare

Return Value :

• DeviceFinder : DeviceFinder DeviceFinder object

Exceptions :

• WebAPIException
  • with error type NotSupportedError, if this feature is not supported.
  • with error type UnknownError, for any other error.

Since : 2.3

Code Example :

var serviceProvider  = webapis.allshare.serviceconnector.getServiceProvider();

try {
  deviceFinder = serviceProvider.getDeviceFinder();
} catch(e) {
  console.log(e.name);
}

Retrieves the current ASF service state.

ServiceState getServiceState();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/allshare

Return Value :

• ServiceState : ServiceState
  ServiceState value

Exceptions :

• WebAPIException
  • with error type NotSupportedError, if this feature is not supported.
  • with error type UnknownError, for any other error.

Since : 2.3

Code Example :

// You must already have a ServiceProvider object
var serviceProvider;

try {
  serviceState = serviceProvider.getServiceState();
} catch(e) {
  console.log(e.name);
}

Callback method invoked when a new device appears on the network.

void ondeviceadded(Device device);

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/allshare

Parameters :

• device : Newly-discovered device

Exceptions :

• WebAPIException
  • with error type TypeMismatchError, if an input parameter is not compatible with the expected type.
  • with error type NotSupportedError, if this feature is not supported.
  • with error type InvalidValuesError, if any input parameter contains an invalid value.
  • with error type UnknownError, for any other error.

Code Example :

var serviceProvider = webapis.allshare.serviceconnector.getServiceProvider();

var monitoringCB = {
  ondeviceadded : function (device) { console.log("new device has appeared :" + device.name); },
  ondeviceremoved : function (device) { console.log("a device has disappeared :" + device.name); }
}

try {
  var listenerId = serviceProvider.getDeviceFinder().addDeviceDiscoveryListener(monitoringCB);
  
} catch(e) {
  console.log(e.name);
}

Callback method invoked when a device disappears from the network.

void ondeviceremoved(Device device);

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/allshare

Parameters :

• device : Device that has disappeared

Exceptions :

• WebAPIException
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type.
  • with error type NotSupportedError, if this feature is not supported.
  • with error type InvalidValuesError, if any input parameter contains an invalid value.
  • with error type UnknownError, for any other error.

Code Example :

var serviceProvider = webapis.allshare.serviceconnector.getServiceProvider();

var monitoringCB = {
  ondeviceadded : function (device) { console.log("new device has appeared :" + device.name); },
  ondeviceremoved : function (device) { console.log("a device has disappeared :" + device.name); }
}

try {
  var listenerId = serviceProvider.getDeviceFinder().addDeviceDiscoveryListener(monitoringCB);
  
} catch(e) {
  console.log(e.name);
}

Returns a Device object with a specific device ID and type.

Device getDevice(DeviceType deviceType, DeviceId id);

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/allshare

Parameters :

• deviceType : Device type i.e. MEDIAPROVIDER
• id : The unique ID of the device

Return Value :

• Device : Device Device object

Exceptions :

• WebAPIException
  • with error type NotSupportedError, if this feature is not supported.
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type.
  • with error type UnknownError, for any other error.

Since : 2.3

Code Example :

var serviceProvider = webapis.allshare.serviceconnector.getServiceProvider();
var mediaProviderId;  // The MEDIAPROVIDER's device ID is assumed to be known

try {
  var deviceFinder = serviceProvider.getDeviceFinder();
  // Get the MediaProvider device object
  var device = deviceFinder.getDevice("MEDIAPROVIDER", mediaProviderId);
  
  // Print the device ID
  console.log(device.id);
  
} catch(e) {
  console.log(e.name);
}

Lists the discovered devices with a specific device type.

DeviceArray getDeviceList(DeviceType deviceType);

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/allshare

Parameters :

• deviceType : Device type i.e. MEDIAPROVIDER

Return Value :

• DeviceArray : DeviceArray Device array

Exceptions :

• WebAPIException
  • with error type NotSupportedError, if this feature is not supported.
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type.
  • with error type UnknownError, for any other error.

Since : 2.3

Code Example :

var serviceProvider = webapis.allshare.serviceconnector.getServiceProvider().

try {
  var deviceFinder = serviceProvider.getDeviceFinder();
  var devices = deviceFinder.getDeviceList("MEDIAPROVIDER");
  
  // Print the number of available MediaProvider devices
  console.log(devices.length);
  
} catch(e) {
  console.log(e.name);
}

Refreshes the list of devices on the network.

void refresh();

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/allshare

Exceptions :

• WebAPIException
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type.
  • with error type NotSupportedError, if this feature is not supported.
  • with error type InvalidValuesError, if any input parameter contains an invalid value.
  • with error type UnknownError, for any other error.

Since : 2.3

Code Example :

var serviceProvider = webapis.allshare.serviceconnector.getServiceProvider();

try {
  var deviceFinder = serviceProvider.getDeviceFinder();
  
  var providers = deviceFinder.getDeviceList("MEDIAPROVIDER");
  if (providers.length == 0) {
    // Refresh the device list and retrieve the provider list again
    deviceFinder.refresh();
    providers = deviceFinder.getDeviceList("MEDIAPROVIDER");
  }
} catch(e) {
  console.log(e.name);
}

Registers a device discovery event listener.

long addDeviceDiscoveryListener(DeviceDiscoveryCallback deviceDiscoveryCallback);

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/allshare

Parameters :

• deviceDiscoveryCallback : Callback method invoked when a device discovery event occurs.

Return Value :

• long : long Event listener ID

Exceptions :

• WebAPIException
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type.
  • with error type NotSupportedError, if this feature is not supported.
  • with error type InvalidValuesError, if any input parameter contains an invalid value.
  • with error type UnknownError, for any other error.

Since : 2.3

Code Example :

var serviceProvider = webapis.allshare.serviceconnector.getServiceProvider();

var monitoringCB = {
  ondeviceadded : function (device) { console.log("new device has appeared :" + device.name); },
  ondeviceremoved : function (device) { console.log("a device has disappeared :" + device.name); }
}

try {
  var listenerId = serviceProvider.getDeviceFinder().addDeviceDiscoveryListener(monitoringCB);
  
} catch(e) {
  console.log(e.name);
}

Unregisters a device discovery event listener.

void removeDeviceDiscoveryListener(long deviceDiscoveryListener);

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/allshare

Parameters :

• deviceDiscoveryListener : Event listener ID

Exceptions :

• WebAPIException
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type.
  • with error type NotSupportedError, if this feature is not supported.
  • with error type InvalidValuesError, if any input parameter contains an invalid value.
  • with error type UnknownError, for any other error.

Since : 2.3

Code Example :

var serviceProvider = webapis.allshare.serviceconnector.getServiceProvider();
var listenerId; // Listener ID returned from addDeviceDiscoveryListener
var monitoringCB = {
  ondeviceadded : function (device) { console.log("new device has appeared :" + device.name); },
  ondeviceremoved : function (device) { console.log("a device has disappeared :" + device.name); }
}

try {
  var listenerId = serviceProvider.getDeviceFinder().addDeviceDiscoveryListener(monitoringCB);
  serviceProvider.getDeviceFinder().removeDeviceDiscoveryListener(listenerId);
} catch(e) {
  console.log(e.name);
}

Callback method for a successful retrieval request.

void onsuccess(ItemList itemList, boolean endOfItems, DeviceId providerId);

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/allshare

Parameters :

• itemList : Item list. If there are no items, an empty list is returned.
• endOfItems : End of items flag
• providerId : Provider device identifier

Code Example :

//onsuccess searchCB
var serviceProvider = webapis.allshare.serviceconnector.getServiceProvider();
var keyword = "foo";

// Define a browse callback
function searchCB(list, endOfItem, providerId){
  // Retrieve the item list
}

function errorCB(error, device){
  console.log(device + " raises " + error);
}

// Define a filter to browse videos only
var filter = new webapis.AttributeFilter("itemType", null, {"VIDEO"});

try {
  var providers = serviceProvider.getDeviceFinder().getDeviceList("MEDIAPROVIDER");
  if (providers.length > 0) {
    // Search for the keyword in the first DMS
    providers[0].search(keyword, 0, 40, searchCB, errorCB, filter);
  }
} catch(e) {
  console.log(e.message);
}

Callback method invoked if an error occurs.

void onerror(WebAPIError error, DeviceId providerId);

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/allshare

Parameters :

• error : Object indicating the error type and message
• providerId : Provider device identifier

Code Example :

//onerror errorCB
var serviceProvider = webapis.allshare.serviceconnector.getServiceProvider();
var keyword = "foo";

// Define a browse callback
function searchCB(list, endOfItem, providerId){
  // Retrieve the item list
}

function errorCB(error, device){
  console.log(device + " raises " + error);
}

// Define a filter to browse videos only
var filter = new webapis.AttributeFilter("itemType", null, {"VIDEO"});

try {
  var providers = serviceProvider.getDeviceFinder().getDeviceList("MEDIAPROVIDER");
  if (providers.length > 0) {
    // Search for the keyword in the first DMS
    providers[0].search(keyword, 0, 40, searchCB, errorCB, filter);
  }
} catch(e) {
  console.log(e.message);
}

Gets the item list in a folder at the specified starting index and count.

void browse(Item folderItem, unsigned long startIndex, unsigned long requestCount, MediaProviderSuccessCallback browseCallback, optional MediaProviderErrorCallback? errorCallback, optional AbstractFilter? browseFilter, optional SortMode? sortMode);

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/allshare

Parameters :

• folderItem : Folder
• startIndex : Starting zero-based offset
• requestCount : Requested number of entries
• browseCallback : Callback invoked when the browse operation is successful. It returns a set of items matching the filter.
• errorCallback [optional][nullable] : Generic error callback for provider-related operations
• browseFilter [optional][nullable] : Browse filter to be applied. Parameters can include AttributeFilter objects constructed with ("itemType", null , ItemType[]).
• sortMode [optional][nullable] : Sorting to use on the content list. Sorting by title, date, artist, or albumTitle attribute is only supported on the Tizen Web platform. Other Web platforms ignore this parameter.

Exceptions :

• WebAPIException
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type.
  • with error type NotSupportedError, if this feature is not supported.
  • with error type InvalidValuesError, if any input parameter contains an invalid value.
  • with error type UnknownError, for any other error.

Since : 2.3

Code Example :

var serviceProvider  = webapis.allshare.serviceconnector.getServiceProvider();

// Define a browse callback
function browseCB(list, endOfItem, providerId) {
  // Retrieve the item list
}

function errorCB(error, deviceId) {
  console.log(error.message);
}

// Define a filter to browse videos only
var filter = new webapis.AttributeFilter("itemType", null, {"VIDEO"});

// Define a sort mode
var mode = new webapis.SortMode("title", "ASC");

try {
  var providers = serviceProvider.getDeviceFinder().getDeviceList("MEDIAPROVIDER");
  if (providers.length > 0) {
    // Retrieves the first DMS from the root folder
    providers[0].browse(providers[0].rootFolder, 0, 10, browseCB, errorCB, filter, mode);
  }
} catch(e) {
  console.log(e.message);
}

Searches content for a specific keyword.

void search(DOMString keyword, unsigned long startIndex, unsigned long requestCount, MediaProviderSuccessCallback successCallback, optional MediaProviderErrorCallback? errorCallback, optional AbstractFilter? searchFilter);

Product : TV, AV, B2B

Privilege Level : Public

Privilege : http://developer.samsung.com/privilege/allshare

Parameters :

• keyword : Search keyword
• startIndex : Starting zero-based offset
• requestCount : Requested number of entries
• successCallback : Callback to invoke when the search operation is successful. It returns a set of items matching the filter.
• errorCallback [optional][nullable] : Generic error callback for provider-related operations
• searchFilter [optional][nullable] : Filter applied to the search result. Parameters can include AttributeFilter objects constructed with ("itemType", null , ItemType[]).

Exceptions :

• WebAPIException
  • with error type TypeMismatchError, if an input parameter is not compatible with its expected type.
  • with error type NotSupportedError, if this feature is not supported.
  • with error type InvalidValuesError, if any input parameter contains an invalid value.
  • with error type UnknownError, for any other error.

Since : 2.3

Code Example :

var serviceProvider = webapis.allshare.serviceconnector.getServiceProvider();
var keyword = "foo";

// Define a browse callback
function searchCB(list, endOfItem, providerId){
  // Retrieve the item list
}

function errorCB(error, device){
  console.log(device + " raises " + error);
}

// Define a filter to browse videos only
var filter = new webapis.AttributeFilter("itemType", null, {"VIDEO"});

try {
  var providers = serviceProvider.getDeviceFinder().getDeviceList("MEDIAPROVIDER");
  if (providers.length > 0) {
    // Search for the keyword in the first DMS
    providers[0].search(keyword, 0, 40, searchCB, errorCB, filter);
  }
} catch(e) {
  console.log(e.message);
}