Class StickerConsumer

Definition

Namespace:: Tizen.Uix.Sticker

Assembly:: Tizen.Uix.Sticker.dll

API Level:: 10

The StickerConsumer provides the methods to retrieve sticker data.


                C#
                
                    Copy
                    
                
            
public static class StickerConsumer : object

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
Boolean

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

API Level: 10

Feature: http://tizen.org/feature/ui_service.sticker

View Source

Deinitialize()

Deinitialize the sticker consumer.

Declaration


                C#
                
                    Copy
                    
                
            
public static void Deinitialize()

API Level: 10

Feature: http://tizen.org/feature/ui_service.sticker

Precondition: StickerConsumer must be initialized.

View Source

GetAllGroupNames()

Retrieves all group names in the sticker database.

Declaration


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

Returns

Type	Description
IEnumerable<String>

API Level: 10

Feature: http://tizen.org/feature/ui_service.sticker

View Source

GetAllKeywords()

Retrieves all keywords in the sticker database.

Declaration


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

Returns

Type	Description
IEnumerable<String>

API Level: 10

Feature: http://tizen.org/feature/ui_service.sticker

View Source

GetAllStickers(Int32, Int32)

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
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
IEnumerable<StickerData>

API Level: 10

Feature: http://tizen.org/feature/ui_service.sticker

View Source

GetGroupImageList()

Retrieves images of all sticker groups in the database.

Declaration


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

Returns

Type	Description
IEnumerable<GroupImage>

API Level: 10

Feature: http://tizen.org/feature/ui_service.sticker

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
IEnumerable<String>

API Level: 10

Feature: http://tizen.org/feature/ui_service.sticker

View Source

GetRecentStickers(Int32)

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
Int32	count	The number of stickers that you want to receive.

Returns

Type	Description
IEnumerable<StickerData>

API Level: 10

Feature: http://tizen.org/feature/ui_service.sticker

View Source

GetStickersByDisplayType(Int32, Int32, 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
Int32	offset	The start position (Starting from zero).
Int32	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
IEnumerable<StickerData>

API Level: 10

Feature: http://tizen.org/feature/ui_service.sticker

View Source

GetStickersByGroup(Int32, Int32, 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
Int32	offset	The start position (Starting from zero).
Int32	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
IEnumerable<StickerData>

API Level: 10

Feature: http://tizen.org/feature/ui_service.sticker

View Source

GetStickersByKeyword(Int32, Int32, 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
Int32	offset	The start position (Starting from zero).
Int32	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
IEnumerable<StickerData>

API Level: 10

Feature: http://tizen.org/feature/ui_service.sticker

View Source

GetStickersByUriType(Int32, Int32, 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
Int32	offset	The start position (Starting from zero).
Int32	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
IEnumerable<StickerData>

API Level: 10

Feature: http://tizen.org/feature/ui_service.sticker

View Source

Initialize()

Initialize sticker consumer.

Declaration


                C#
                
                    Copy
                    
                
            
public static void Initialize()

API Level: 10

Privilege Level: public

Privilege: http://tizen.org/privilege/mediastorage

Feature: http://tizen.org/feature/ui_service.sticker

Events

View Source

Deleted

Called when the stickers are deleted.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<DeletedEventArgs> Deleted

Event Type

Type	Description
EventHandler<DeletedEventArgs>

API Level: 10

View Source

Inserted

Called when the stickers are inserted.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<InsertedEventArgs> Inserted

Event Type

Type	Description
EventHandler<InsertedEventArgs>

API Level: 10

View Source

Updated

Called when the stickers are updated.

Declaration


                C#
                
                    Copy
                    
                
            
public static event EventHandler<UpdatedEventArgs> Updated

Event Type

Type	Description
EventHandler<UpdatedEventArgs>