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#Copypublic static class StickerConsumer
- Inheritance
-
System.ObjectStickerConsumer
Properties
Declaration
C#Copypublic static bool Initialized { get; }
Property Value
Type | Description |
---|---|
Boolean |
Methods
Declaration
C#Copypublic 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. |
API Level: 10
Feature: http://tizen.org/feature/ui_service.sticker
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: StickerConsumer must be initialized.
Declaration
C#Copypublic static IEnumerable<string> GetAllGroupNames()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.String> |
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
Declaration
C#Copypublic static IEnumerable<string> GetAllKeywords()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.String> |
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
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#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 exception can be due to operation failed. |
API Level: 10
Feature: http://tizen.org/feature/ui_service.sticker
Declaration
C#Copypublic static IEnumerable<GroupImage> GetGroupImageList()
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<GroupImage> |
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
GetGroupNamesByDisplayType(DisplayType)
Retrieves all group names assigned to stickers with a matching display displayType
.
Declaration
C#Copypublic 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<System.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. |
API Level: 10
Feature: http://tizen.org/feature/ui_service.sticker
GetRecentStickers(Int32)
Gets recently used stickers list. The most recently used stickers are delivered in order.
Declaration
C#Copypublic static IEnumerable<StickerData> GetRecentStickers(int count)
Parameters
Type | Name | Description |
---|---|---|
Int32 | count | The number of stickers that you want to receive. |
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 exception can be due to operation failed. |
API Level: 10
Feature: http://tizen.org/feature/ui_service.sticker
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#Copypublic 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 |
---|---|
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 exception can be due to operation failed. |
API Level: 10
Feature: http://tizen.org/feature/ui_service.sticker
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#Copypublic 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. |
System.String | groupName | The group name of the sticker for getting sticker data. |
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 exception can be due to operation failed. |
API Level: 10
Feature: http://tizen.org/feature/ui_service.sticker
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#Copypublic 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. |
System.String | keyword | The keyword of the sticker for getting sticker data. |
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 exception can be due to operation failed. |
API Level: 10
Feature: http://tizen.org/feature/ui_service.sticker
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#Copypublic 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 |
---|---|
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 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. |
UnauthorizedAccessException | This exception can be due to permission denied. |
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
Privilege Level: public
Privilege: http://tizen.org/privilege/mediastorage
Feature: http://tizen.org/feature/ui_service.sticker
Events
Declaration
C#Copypublic static event EventHandler<DeletedEventArgs> Deleted
Event Type
Type | Description |
---|---|
System.EventHandler<DeletedEventArgs> |
API Level: 10
Declaration
C#Copypublic static event EventHandler<InsertedEventArgs> Inserted
Event Type
Type | Description |
---|---|
System.EventHandler<InsertedEventArgs> |
API Level: 10
Declaration
C#Copypublic static event EventHandler<UpdatedEventArgs> Updated
Event Type
Type | Description |
---|---|
System.EventHandler<UpdatedEventArgs> |