UserWiseSDK.Surveys.SurveysModule Class Reference

Inheritance diagram for UserWiseSDK.Surveys.SurveysModule:

Public Member Functions
void	InitializeSurveyInvite (Survey survey)
	Initialize a survey invite with just the survey. This will attempt to find any previously used survey invite. More...
void	InitializeSurveyInvite (Survey survey, string responseId)
	Initialize a survey invite with the survey and a known response id. This method is generally not called directly. More...
void	SetSurveyInviteResponse (Survey survey, string responseId, string inviteId, bool wasAccepted)
	Sets the player's response to the survey invite. If the player declines, the survey will not load. However, if they accept, the survey will load, removing the user from the current screen. More...
Public Member Functions inherited from UserWiseSDK.Common.Modules.BaseModule< Survey >
string	GetModuleName ()
	Returns the module name. More...
T	Get (string id)
T	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< SurveyInviteInitializedEventArgs >	OnSurveyInviteInitialized
	Emitted on survey invite initialization success/failure. More...
EventHandler< SurveyResponseIdEventArgs >	OnSurveyEntered
	Emitted once the player has entered the survey. More...
EventHandler< SurveyResponseIdEventArgs >	OnSurveyEnterFailed
	Emitted if the player could not be loaded into the survey. More...
EventHandler< SurveyResponseIdEventArgs >	OnSurveyCompleted
	Emitted if the player successfully completed the survey. More...
EventHandler< SurveyResponseIdEventArgs >	OnSurveyClosed
	Emitted if the player closed the survey. More...
Events inherited from UserWiseSDK.Common.Modules.BaseModule< Survey >
EventHandler< EventArgs >	OnLoadFailed
	Emitted when the data for this module could not be loaded from the API and/or cache. More...
EventHandler< OnLoadedEventArgs >	OnLoaded
	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< Survey >
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< Survey >
UserWise	userWise
Properties inherited from UserWiseSDK.Common.Modules.BaseModule< Survey >
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...

Member Function Documentation

InitializeSurveyInvite() [1/2]

void UserWiseSDK.Surveys.SurveysModule.InitializeSurveyInvite ( Survey  survey )

inline

Initialize a survey invite with just the survey. This will attempt to find any previously used survey invite.

Behind the scenes this will start the lifecycle of a Survey Response.

Parameters

survey

The survey to create an invite for

InitializeSurveyInvite() [2/2]

void UserWiseSDK.Surveys.SurveysModule.InitializeSurveyInvite ( Survey  survey, string  responseId  )

inline

Initialize a survey invite with the survey and a known response id. This method is generally not called directly.

SetSurveyInviteResponse()

void UserWiseSDK.Surveys.SurveysModule.SetSurveyInviteResponse ( Survey  survey, string  responseId, string  inviteId, bool  wasAccepted  )

inline

Sets the player's response to the survey invite. If the player declines, the survey will not load. However, if they accept, the survey will load, removing the user from the current screen.

Member Data Documentation

UpcomingStartsBefore

DateTime? UserWiseSDK.Surveys.SurveysModule.UpcomingStartsBefore = null

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

Event Documentation

OnSurveyClosed

EventHandler<SurveyResponseIdEventArgs> UserWiseSDK.Surveys.SurveysModule.OnSurveyClosed

Emitted if the player closed the survey.

Note: This does not mean that the survey was not completed.

OnSurveyCompleted

EventHandler<SurveyResponseIdEventArgs> UserWiseSDK.Surveys.SurveysModule.OnSurveyCompleted

Emitted if the player successfully completed the survey.

Though this can be an indicator in realtime, we suggest you verify any claims through the use of our server-to-server webhook integrations.

Note: This does not mean that the survey has been closed.

OnSurveyEntered

EventHandler<SurveyResponseIdEventArgs> UserWiseSDK.Surveys.SurveysModule.OnSurveyEntered

Emitted once the player has entered the survey.

OnSurveyEnterFailed

EventHandler<SurveyResponseIdEventArgs> UserWiseSDK.Surveys.SurveysModule.OnSurveyEnterFailed

Emitted if the player could not be loaded into the survey.

OnSurveyInviteInitialized

EventHandler<SurveyInviteInitializedEventArgs> UserWiseSDK.Surveys.SurveysModule.OnSurveyInviteInitialized

Emitted on survey invite initialization success/failure.

---

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

• userwise_sdk_source/userwise_sdk/Surveys/SurveysModule.cs