UserWise Unity SDK  3.0.0
Public Member Functions | Public Attributes | Events | List of all members
UserWiseSDK.Messages.MessagesModule Class Reference

Acts as the public interface used for when managing UserWise messages. More...

Inheritance diagram for UserWiseSDK.Messages.MessagesModule:
UserWiseSDK.Common.Modules.BaseModule< Message >

Public Member Functions

void InitializeMessage (Message message)
 Sets the message as initialized for the player. This should be called prior to displaying the message to the user. More...
 
- Public Member Functions inherited from UserWiseSDK.Common.Modules.BaseModule< Message >
string GetModuleName ()
 Returns the module name. More...
 
Get (string id)
 
FindInActiveOrUpcoming (Predicate< T > predicate)
 

Public Attributes

DateTime? UpcomingStartsBefore = null
 Configures the DateTime that will be used to filter upcoming content returned from the UserWise API. More...
 

Events

EventHandler< OnMessageInitializedEventArgsOnMessageInitialized
 Emitted when a message impression has been initialized on the UserWise server. More...
 
EventHandler< OnMessageInitializationFailedEventArgsOnMessageInitializationFailed
 Emitted when a message impression initalization failed. More...
 
- Events inherited from UserWiseSDK.Common.Modules.BaseModule< Message >
EventHandler< EventArgs > OnLoadFailed
 Emitted when the data for this module could not be loaded from the API and/or cache. More...
 
EventHandler< OnLoadedEventArgsOnLoaded
 Emitted when the data for this module has been reloaded. Currently, either from the API, or through the cached data. More...
 
EventHandler< OnActiveEventArgs< T > > OnActive
 Emitted when a type of T has been marked as active. More...
 
EventHandler< OnInactiveEventArgs< T > > OnInactive
 Emitted when a type of T has been marked as inactive. More...
 

Additional Inherited Members

- Protected Member Functions inherited from UserWiseSDK.Common.Modules.BaseModule< Message >
void EmitOnLoadFailed (object sender)
 
void EmitOnLoaded (object sender, OnLoadedEventArgs e)
 
void ResetModuleData ()
 
void LoadFromCache (ModuleCacheFile moduleCacheFile)
 
void WriteToCache (ModuleCacheFile moduleCacheFile)
 
- Protected Attributes inherited from UserWiseSDK.Common.Modules.BaseModule< Message >
UserWise userWise
 
- Properties inherited from UserWiseSDK.Common.Modules.BaseModule< Message >
List< T > Active [get, protected set]
 A List of active (available) module stored items. More...
 
List< T > Upcoming [get, protected set]
 A List of upcoming (soon to be available) module stored items. More...
 

Detailed Description

Acts as the public interface used for when managing UserWise messages.

Member Function Documentation

◆ InitializeMessage()

void UserWiseSDK.Messages.MessagesModule.InitializeMessage ( Message  message)
inline

Sets the message as initialized for the player. This should be called prior to displaying the message to the user.

Parameters
messageMessage to initialize an impression for

Member Data Documentation

◆ UpcomingStartsBefore

DateTime? UserWiseSDK.Messages.MessagesModule.UpcomingStartsBefore = null

Configures the DateTime that will be used to filter upcoming content returned from the UserWise API.

Event Documentation

◆ OnMessageInitializationFailed

EventHandler<OnMessageInitializationFailedEventArgs> UserWiseSDK.Messages.MessagesModule.OnMessageInitializationFailed

Emitted when a message impression initalization failed.

◆ OnMessageInitialized

EventHandler<OnMessageInitializedEventArgs> UserWiseSDK.Messages.MessagesModule.OnMessageInitialized

Emitted when a message impression has been initialized on the UserWise server.


The documentation for this class was generated from the following file: