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.
virtual bool	IsPersonalWallpaperEnabled ()=0
	Determine if the personal wall-paper feature enabled by OP.
virtual IWallpaperItem *	GetCurrentPersonalWallpaperItem ()=0
	Get the current user's persional wall-paper item.
virtual IList< IWallpaperItem * > *	GetPersonalWallpaperList ()=0
	Get the current user's personal wall-paper list.
virtual SDKError	SetPersonalWallpaper (IWallpaperItem *item)=0
	Set the current user's personal wall-paper.
virtual IWallpaperItem *	GetPersonalWallpaperItemByID (const zchar_t *wallpaperID)=0
	Get the personal wall-paper item by wall-paper ID.

Detailed Description

Meeting Wall-paper setting interface.

Definition at line 2020 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.

Note

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

GetCurrentPersonalWallpaperItem()

virtual IWallpaperItem * IWallpaperSettingContext::GetCurrentPersonalWallpaperItem ( )

pure virtual

Get the current user's persional wall-paper item.

Returns

The current user's personal wall-paper config.

Note

Only login user has this config. 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.

GetPersonalWallpaperItemByID()

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

pure virtual

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

Returns

The personal wall-paper item with the wall-paper ID.

Note

Only valid for login user.

GetPersonalWallpaperList()

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

pure virtual

Get the current user's personal wall-paper list.

Returns

The current user's personal wall-paper list.

Note

Only login user has this config 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.

IsPersonalWallpaperEnabled()

virtual bool IWallpaperSettingContext::IsPersonalWallpaperEnabled ( )

pure virtual

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

Returns

true indicates the feature enabled. 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. For detailed error codes, see the SDKError enum.

Note

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. For detailed error codes, see the SDKError enum.

SetPersonalWallpaper()

virtual SDKError IWallpaperSettingContext::SetPersonalWallpaper ( IWallpaperItem * item )

pure virtual

Set the current user's personal wall-paper.

Parameters

item	Personal wall-paper item need to set.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

Note

Only valid for login user.