Class StickerConsumer

Definition

Namespace:: Tizen.Uix.Sticker

Assembly:: Tizen.Uix.Sticker.dll

The StickerConsumer provides the methods to retrieve sticker data.


                C#
                
                    Copy
                    
                
            
public static class StickerConsumer

Inheritance: object

StickerConsumer

Properties

View Source

Initialized

Gets a flag indicating whether the StickerConsumer is initialized

Declaration


                C#
                
                    Copy
                    
                
            
public static bool Initialized { get; }

Property Value

Type	Description
bool

Methods

View Source

AddRecentData(StickerData)

Adds entry to recently used stickers list.

Declaration


                C#
                
                    Copy
                    
                
            
public static void AddRecentData(StickerData data)

Parameters

Type	Name	Description
StickerData	data	The sticker data class

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

Deinitialize()

Deinitialize the sticker consumer.

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

GetAllGroupNames()

Retrieves all group names in the sticker database.

Declaration


                C#
                
                    Copy
                    
                
            
public static IEnumerable<string> GetAllGroupNames()

Returns

Type	Description
System.Collections.Generic.IEnumerable<T><string>

Exceptions

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

View Source

GetAllKeywords()

Retrieves all keywords in the sticker database.

Declaration


                C#
                
                    Copy
                    
                
            
public static IEnumerable<string> GetAllKeywords()

Returns

Type	Description
System.Collections.Generic.IEnumerable<T><string>

Exceptions

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

View Source

GetAllStickers(int, int)

Retrieves all sticker data in the sticker database. If you set the offset as 10 and count as 10, then only records from 10 to 19 will be retrieved.

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 exception can be due to operation failed.

View Source

GetGroupImageList()

Retrieves images of all sticker groups in the database.

Declaration


                C#
                
                    Copy
                    
                
            
public static IEnumerable<GroupImage> GetGroupImageList()

Returns

Type	Description
System.Collections.Generic.IEnumerable<T><GroupImage>

Exceptions

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

View Source

GetGroupNamesByDisplayType(DisplayType)

Retrieves all group names assigned to stickers with a matching display displayType.

Declaration


                C#
                
                    Copy
                    
                
            
public static IEnumerable<string> GetGroupNamesByDisplayType(DisplayType displayType)

Parameters

Type	Name	Description
DisplayType	displayType	The display type of the sticker for getting sticker data.

Returns

Type	Description
System.Collections.Generic.IEnumerable<T><string>

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

GetRecentStickers(int)

Gets recently used stickers list. The most recently used stickers are delivered in order.

Declaration


                C#
                
                    Copy
                    
                
            
public static IEnumerable<StickerData> GetRecentStickers(int count)

Parameters

Type	Name	Description
int	count	The number of stickers that you want to receive.

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 exception can be due to operation failed.

View Source

GetStickersByDisplayType(int, int, DisplayType)

Retrieves all sticker data in the sticker database using display type. If you set the offset as 10 and count as 10, then only records from 10 to 19 will be retrieved.

Declaration


                C#
                
                    Copy
                    
                
            
public static IEnumerable<StickerData> GetStickersByDisplayType(int offset, int count, DisplayType displayType)

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.
DisplayType	displayType	The display type of the sticker for getting sticker data.

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 exception can be due to operation failed.

View Source

GetStickersByGroup(int, int, string)

Retrieves all sticker data in the sticker database using group name. If you set the offset as 10 and count as 10, then only records from 10 to 19 will be retrieved.

Declaration


                C#
                
                    Copy
                    
                
            
public static IEnumerable<StickerData> GetStickersByGroup(int offset, int count, string groupName)

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.
string	groupName	The group name of the sticker for getting sticker data.

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 exception can be due to operation failed.

View Source

GetStickersByKeyword(int, int, string)

Retrieves all sticker data in the sticker database using keyword. If you set the offset as 10 and count as 10, then only records from 10 to 19 will be retrieved.

Declaration


                C#
                
                    Copy
                    
                
            
public static IEnumerable<StickerData> GetStickersByKeyword(int offset, int count, string keyword)

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.
string	keyword	The keyword of the sticker for getting sticker data.

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 exception can be due to operation failed.

View Source

GetStickersByUriType(int, int, UriType)

Retrieves all sticker data in the sticker database using URI type. If you set the offset as 10 and count as 10, then only records from 10 to 19 will be retrieved.

Declaration


                C#
                
                    Copy
                    
                
            
public static IEnumerable<StickerData> GetStickersByUriType(int offset, int count, UriType uriType)

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.
UriType	uriType	The URI type of the sticker for getting sticker data.

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 exception can be due to operation failed.

View Source

Initialize()

Initialize sticker consumer.

Declaration


                C#
                
                    Copy
                    
                
            
public static void Initialize()

Exceptions

Type

Condition

System.NotSupportedException

The required feature is not supported.

System.UnauthorizedAccessException

This exception can be due to permission denied.

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.

Events

View Source

Deleted

Called when the stickers are deleted.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<DeletedEventArgs> Deleted

Event Type

Type	Description
System.EventHandler<TEventArgs><DeletedEventArgs>

View Source

Inserted

Called when the stickers are inserted.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<InsertedEventArgs> Inserted

Event Type

Type	Description
System.EventHandler<TEventArgs><InsertedEventArgs>

View Source

Updated

Called when the stickers are updated.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<UpdatedEventArgs> Updated

Event Type

Type	Description
System.EventHandler<TEventArgs><UpdatedEventArgs>