Class StickerProvider

Definition

Namespace:: Tizen.Uix.Sticker

Assembly:: Tizen.Uix.Sticker.dll

The StickerProvider provides the methods to create/update/delete the sticker data.


                C#
                
                    Copy
                    
                
            
public static class StickerProvider

Inheritance: object

StickerProvider

Properties

View Source

Initialized

Gets a flag indicating whether the StickerProvider is initialized

Declaration


                C#
                
                    Copy
                    
                
            
public static bool Initialized { get; }

Property Value

Type	Description
bool

View Source

StickerCount

Gets the count of stickers stored by the provider application.

Declaration


                C#
                
                    Copy
                    
                
            
public static int StickerCount { get; }

Property Value

Type	Description
int

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.
System.InvalidOperationException	This exception can be due to operation failed.

Methods

View Source

Deinitialize()

Deinitialize the sticker provider.

Declaration


                C#
                
                    Copy
                    
                
            
public static void Deinitialize()

Exceptions

Type	Condition
System.NotSupportedException	The required feature is not supported.
System.InvalidOperationException	This exception can be due to operation failed.

View Source

DeleteData(string)

Deletes a sticker data in the sticker database.

Declaration


                C#
                
                    Copy
                    
                
            
public static void DeleteData(string uri)

Parameters

Type	Name	Description
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:

This exception can be due to operation failed.
This exception can be due to no such file.

View Source

DeleteData(StickerData)

Deletes a sticker data in the sticker database.

Declaration


                C#
                
                    Copy
                    
                
            
public 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.

View Source

GetAllStickers(int, int)

Retrieves all sticker data in the sticker database.

Declaration


                C#
                
                    Copy
                    
                
            
public static IEnumerable<StickerData> GetAllStickers(int offset, int count)

Parameters

Type	Name	Description
int	offset	The start position (Starting from zero).
int	count	The number of stickers to be retrieved with respect to the offset.

Returns

Type	Description
System.Collections.Generic.IEnumerable<T><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:

This exception can be due to out of memory.
This exception can be due to operation failed.

View Source

Initialize()

Initialize sticker provider.

Declaration


                C#
                
                    Copy
                    
                
            
public static void Initialize()

Exceptions

Type

Condition

System.NotSupportedException

The required feature is not supported.

System.InvalidOperationException

This can occur due to the following reasons:

This exception can be due to out of memory.
This exception can be due to operation failed.

View Source

InsertData(string)

Inserts a sticker data using JSON file.

Declaration


                C#
                
                    Copy
                    
                
            
public static Task InsertData(string jsonPath)

Parameters

Type	Name	Description
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.

View Source

InsertData(StickerData)

Inserts a sticker data to the sticker database.

Declaration


                C#
                
                    Copy
                    
                
            
public 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:

This exception can be due to operation failed.
This exception can be due to file exists.
This exception can be due to no such file.

View Source

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#
                
                    Copy
                    
                
            
public 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:

This exception can be due to operation failed.
This exception can be due to no such file.

View Source

UpdateData(StickerData)

Updates a sticker data in the sticker database.

Declaration


                C#
                
                    Copy
                    
                
            
public 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:

This exception can be due to operation failed.
This exception can be due to file exists.
This exception can be due to no such file.