C# Class MediaAppSample.Core.Services.NotificationsService

Inheritance: ServiceBase

Mostrar archivo Open project: Microsoft/TVHelpers

Public Methods

Method	Description
ClearTile ( IModel model ) : void	Clears a tile associated to the model specified. How it determines which tile(s) to clear is determined by the class implementing this interface. If the platform does not support tiles, then the implementation should do nothing.
CreateOrUpdateTileAsync ( IModel model ) : Task	Creates or updates one or multiple live tiles on the executing platform. How it is manifests itself is determined by the class that implements this interface. If the platform does not support this feature, then the implementation should do nothing.
DeleteTileAsync ( IModel model ) : Task	Deletes a tile associated to the model specified. How it determines which tile to delete is determined by the class implementing this interface. If the platform does not support tiles, then the implementation should do nothing.
DisplayToast ( IModel model ) : void	Displays a toasts associated to the tile specified. How it determines what should be displayed is determined by the class implementing this interface. If the platform does not support toasts, then the implementation should do nothing.
HasTile ( IModel model ) : bool	Checks to see if a tile exists associated the the model specified. How it determines which tile to check against is determined by the class implementing this interface. If the platform does not support tiles, then the implementation should do nothing.
SignoutAsync ( ) : System.Threading.Tasks.Task	On signout of a user, clear tiles, toasts, notifications
UpdateAllSecondaryTilesAsync ( CancellationToken ct ) : System.Threading.Tasks.Task	Updates all tiles or any other UI features currently in use on the device.

Protected Methods

Method	Description
Initialize ( ) : void	Initialization logic which is called on launch of this application.

Private Methods

Method	Description
CreateOrUpdateSecondaryTileAsync ( SecondaryTile tile, TileVisualOptions options ) : Task
NotificationsService ( ) : MediaAppSample.Core.Models

Method Details

ClearTile() public method

Clears a tile associated to the model specified. How it determines which tile(s) to clear is determined by the class implementing this interface. If the platform does not support tiles, then the implementation should do nothing.

public ClearTile ( IModel model ) : void
model	IModel	Model which contains the data necessary to find the tile to clear.
return	void

CreateOrUpdateTileAsync() public method

Creates or updates one or multiple live tiles on the executing platform. How it is manifests itself is determined by the class that implements this interface. If the platform does not support this feature, then the implementation should do nothing.

public CreateOrUpdateTileAsync ( IModel model ) : Task
model	IModel	Model which contains the data necessary to create a new tile or to find the tile to update
return	Task

DeleteTileAsync() public method

Deletes a tile associated to the model specified. How it determines which tile to delete is determined by the class implementing this interface. If the platform does not support tiles, then the implementation should do nothing.

public DeleteTileAsync ( IModel model ) : Task
model	IModel	Model which contains the data necessary to find the tile to delete.
return	Task

DisplayToast() public method

Displays a toasts associated to the tile specified. How it determines what should be displayed is determined by the class implementing this interface. If the platform does not support toasts, then the implementation should do nothing.

public DisplayToast ( IModel model ) : void
model	IModel	Model which contains the data needed for the toast.
return	void

HasTile() public method

Checks to see if a tile exists associated the the model specified. How it determines which tile to check against is determined by the class implementing this interface. If the platform does not support tiles, then the implementation should do nothing.

public HasTile ( IModel model ) : bool
model	IModel	Model which contains the data to find the tile.
return	bool

Initialize() protected method

Initialization logic which is called on launch of this application.

protected Initialize ( ) : void
return	void

SignoutAsync() public method

On signout of a user, clear tiles, toasts, notifications

public SignoutAsync ( ) : System.Threading.Tasks.Task
return	System.Threading.Tasks.Task

UpdateAllSecondaryTilesAsync() public method

Updates all tiles or any other UI features currently in use on the device.

public UpdateAllSecondaryTilesAsync ( CancellationToken ct ) : System.Threading.Tasks.Task
ct	CancellationToken
return	System.Threading.Tasks.Task