IWallpaperSettingContext Class Reference

Meeting Wall-paper setting interface. More...

#include <setting_service_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IWallpaperSettingContextEvent *pEvent)=0
	Meeting wall-paper callback handler.
virtual bool	IsMeetingWallpaperEnabled ()=0
	Determine if the meeting wall-paper feature enabled by OP.
virtual bool	IsMeetingWallpaperThumbsReady ()=0
	Determine if meeting wall-paper thumbnail ready.
virtual IWallpaperItem *	GetCurrentMeetingWallpaperItem ()=0
	Get the meeting wall-paper item.
virtual IList< IWallpaperItem * > *	GetMeetingWallpaperList ()=0
	Get the meeting wall-paper list.
virtual SDKError	SetMeetingWallpaper (IWallpaperItem *item)=0
	Set the meeting wall-paper item.
virtual IWallpaperItem *	GetMeetingWallpaperItemByID (const zchar_t *wallpaperID)=0
	Get the meeting wall-paper item by wall-paper ID.

Detailed Description

Meeting Wall-paper setting interface.

Definition at line 1558 of file setting_service_interface.h.

Member Function Documentation

GetCurrentMeetingWallpaperItem()

virtual IWallpaperItem * IWallpaperSettingContext::GetCurrentMeetingWallpaperItem ( )

pure virtual

Get the meeting wall-paper item.

Returns

The current using meeting wall-paper config.

Remarks

If select None, the wall-paper ID is empty.

GetMeetingWallpaperItemByID()

virtual IWallpaperItem * IWallpaperSettingContext::GetMeetingWallpaperItemByID ( const zchar_t * wallpaperID )

pure virtual

Get the meeting wall-paper item by wall-paper ID.

Returns

The meeting wall-paper with the wall-paper ID.

GetMeetingWallpaperList()

virtual IList< IWallpaperItem * > * IWallpaperSettingContext::GetMeetingWallpaperList ( )

pure virtual

Get the meeting wall-paper list.

Returns

The meeting wall-paper list.

IsMeetingWallpaperEnabled()

virtual bool IWallpaperSettingContext::IsMeetingWallpaperEnabled ( )

pure virtual

Determine if the meeting wall-paper feature enabled by OP.

Returns

True indicates the feature enabled. Otherwise false.

IsMeetingWallpaperThumbsReady()

virtual bool IWallpaperSettingContext::IsMeetingWallpaperThumbsReady ( )

pure virtual

Determine if meeting wall-paper thumbnail ready.

Returns

True indicates ready. Otherwise false.

SetEvent()

virtual SDKError IWallpaperSettingContext::SetEvent ( IWallpaperSettingContextEvent * pEvent )

pure virtual

Meeting wall-paper callback handler.

Parameters

pEvent

A pointer to the IWallpaperSettingContextEvent that receives wall-paper event.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

Remarks

Call the function before using any other interface of the same class.

SetMeetingWallpaper()

virtual SDKError IWallpaperSettingContext::SetMeetingWallpaper ( IWallpaperItem * item )

pure virtual

Set the meeting wall-paper item.

Parameters

item	The meeting wall-paper item need to set.

Returns

If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.