Class StickerConsumer
Definition
- Assembly:
- Tizen.Uix.Sticker.dll
The StickerConsumer provides the methods to retrieve sticker data.
public static class StickerConsumer
- Inheritance
-
objectStickerConsumer
Properties
View SourceInitialized
Gets a flag indicating whether the StickerConsumer is initialized
Declaration
public static bool Initialized { get; }
Property Value
| Type | Description |
|---|---|
| bool |
Methods
View SourceAddRecentData(StickerData)
Adds entry to recently used stickers list.
Declaration
public static void AddRecentData(StickerData data)
Parameters
| Type | Name | Description |
|---|---|---|
| StickerData | data | The sticker data class |
Deinitialize()
Deinitialize the sticker consumer.
Declaration
public static void Deinitialize()
GetAllGroupNames()
Retrieves all group names in the sticker database.
Declaration
public static IEnumerable<string> GetAllGroupNames()
Returns
| Type | Description |
|---|---|
| IEnumerable<><string> |
GetAllKeywords()
Retrieves all keywords in the sticker database.
Declaration
public static IEnumerable<string> GetAllKeywords()
Returns
| Type | Description |
|---|---|
| IEnumerable<><string> |
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
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 |
|---|---|
| IEnumerable<><StickerData> |
GetGroupImageList()
Retrieves images of all sticker groups in the database.
Declaration
public static IEnumerable<GroupImage> GetGroupImageList()
Returns
| Type | Description |
|---|---|
| IEnumerable<><GroupImage> |
GetGroupNamesByDisplayType(DisplayType)
Retrieves all group names assigned to stickers with a matching display displayType.
Declaration
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> |
GetRecentStickers(int)
Gets recently used stickers list. The most recently used stickers are delivered in order.
Declaration
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 |
|---|---|
| IEnumerable<><StickerData> |
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
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 |
|---|---|
| IEnumerable<><StickerData> |
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
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 |
|---|---|
| IEnumerable<><StickerData> |
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
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 |
|---|---|
| IEnumerable<><StickerData> |
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
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 |
|---|---|
| IEnumerable<><StickerData> |
Initialize()
Initialize sticker consumer.
Declaration
public static void Initialize()
Events
View SourceDeleted
Called when the stickers are deleted.
Declaration
public static event EventHandler<DeletedEventArgs> Deleted
Event Type
| Type | Description |
|---|---|
| EventHandler<><DeletedEventArgs> |
Inserted
Called when the stickers are inserted.
Declaration
public static event EventHandler<InsertedEventArgs> Inserted
Event Type
| Type | Description |
|---|---|
| EventHandler<><InsertedEventArgs> |
Updated
Called when the stickers are updated.
Declaration
public static event EventHandler<UpdatedEventArgs> Updated
Event Type
| Type | Description |
|---|---|
| EventHandler<><UpdatedEventArgs> |