Class StickerProvider
Definition
- Namespace:
- Tizen.Uix.Sticker
- Assembly:
- Tizen.Uix.Sticker.dll
- API Level:
- 10
The StickerProvider provides the methods to create/update/delete the sticker data.
C#Copypublic static class StickerProvider
- Inheritance
-
System.ObjectStickerProvider
Properties
Declaration
C#Copypublic static bool Initialized { get; }
Property Value
Type | Description |
---|---|
Boolean |
Declaration
C#Copypublic static int StickerCount { get; }
Property Value
Type | Description |
---|---|
Int32 |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | The required feature is not supported. |
System.InvalidOperationException | This exception can be due to operation failed. |
API Level: 10
Feature: http://tizen.org/feature/ui_service.sticker
Methods
Declaration
C#Copypublic static void Deinitialize()
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | The required feature is not supported. |
System.InvalidOperationException | This exception can be due to operation failed. |
API Level: 10
Feature: http://tizen.org/feature/ui_service.sticker
Precondition: StickerProvider must be initialized.
Declaration
C#Copypublic static void DeleteData(string uri)
Parameters
Type | Name | Description |
---|---|---|
System.String | uri | The URI of the sticker data to be deleted. |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | The required feature is not supported. |
System.InvalidOperationException | This can occur due to the following reasons: 1) This exception can be due to operation failed. 2) This exception can be due to no such file. |
API Level: 10
Feature: http://tizen.org/feature/ui_service.sticker
Declaration
C#Copypublic static void DeleteData(StickerData data)
Parameters
Type | Name | Description |
---|---|---|
StickerData | data | The sticker data to be deleted. |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | The required feature is not supported. |
System.ArgumentException | This exception can be due to an invalid parameter. |
System.InvalidOperationException | This exception can be due to operation failed. |
API Level: 10
Feature: http://tizen.org/feature/ui_service.sticker
Declaration
C#Copypublic static IEnumerable<StickerData> GetAllStickers(int offset, int count)
Parameters
Type | Name | Description |
---|---|---|
Int32 | offset | The start position (Starting from zero). |
Int32 | count | The number of stickers to be retrieved with respect to the offset. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<StickerData> |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | The required feature is not supported. |
System.ArgumentException | This exception can be due to an invalid parameter. |
System.InvalidOperationException | This can occur due to the following reasons: 1) This exception can be due to out of memory. 2) This exception can be due to operation failed. |
API Level: 10
Feature: http://tizen.org/feature/ui_service.sticker
Declaration
C#Copypublic static void Initialize()
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | The required feature is not supported. |
System.InvalidOperationException | This can occur due to the following reasons: 1) This exception can be due to out of memory. 2) This exception can be due to operation failed. |
API Level: 10
Feature: http://tizen.org/feature/ui_service.sticker
Declaration
C#Copypublic static Task InsertData(string jsonPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | jsonPath | The path of JSON file containing sticker data to be saved |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task |
Remarks
All data except thumbnail, description, and display_type must be set in the JSON file to insert the sticker data.
jsonPath
must have a non-null value and must be an existing file.
If the URI type is local path, the sticker file is copied to a sticker directory.
It is recommended to delete your sticker files after inserting a sticker data.
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | The required feature is not supported. |
System.ArgumentException | This exception can be due to an invalid parameter. |
System.InvalidOperationException | This exception can be due to operation failed. |
API Level: 10
Feature: http://tizen.org/feature/ui_service.sticker
Declaration
C#Copypublic static void InsertData(StickerData data)
Parameters
Type | Name | Description |
---|---|---|
StickerData | data | The sticker data to be saved. |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | The required feature is not supported. |
System.ArgumentException | This exception can be due to an invalid parameter. |
System.InvalidOperationException | This can occur due to the following reasons: 1) This exception can be due to operation failed. 2) This exception can be due to file exists. 3) This exception can be due to no such file. |
API Level: 10
Feature: http://tizen.org/feature/ui_service.sticker
SetGroupImage(GroupImage)
Sets the image of the sticker group. URI must be a relative path like '/res/smile.png' when URI type is local path.
Declaration
C#Copypublic static void SetGroupImage(GroupImage groupImage)
Parameters
Type | Name | Description |
---|---|---|
GroupImage | groupImage | The group image to be set. |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | The required feature is not supported. |
System.ArgumentException | This exception can be due to an invalid parameter. |
System.InvalidOperationException | This can occur due to the following reasons: 1) This exception can be due to operation failed. 2) This exception can be due to no such file. |
API Level: 10
Feature: http://tizen.org/feature/ui_service.sticker
Declaration
C#Copypublic static void UpdateData(StickerData data)
Parameters
Type | Name | Description |
---|---|---|
StickerData | data | The sticker data to be updated. |
Exceptions
Type | Condition |
---|---|
System.NotSupportedException | The required feature is not supported. |
System.ArgumentException | This exception can be due to an invalid parameter. |
System.InvalidOperationException | This can occur due to the following reasons: 1) This exception can be due to operation failed. 2) This exception can be due to file exists. 3) This exception can be due to no such file. |