Class PolarisRequestClient

Client for displaying recommendation requests in Phoenix.

Inheritance
System.Object
PolarisRequestClient
Namespace: Phoenix.Polaris
Assembly: Phoenix.Plugin.Polaris.dll
Syntax
public class PolarisRequestClient : IPolarisPhoenixRequestClient

Constructors

View Source

PolarisRequestClient(IPhoenixLogger, IDeviceManager)

Initializes a new instance of the PolarisRequestClient class.

Declaration
public PolarisRequestClient(IPhoenixLogger logger, IDeviceManager deviceManager)
Parameters
Type Name Description
IPhoenixLogger logger

The logger.
IDeviceManager deviceManager

The device manager.

Properties

View Source

DeviceManager

Declaration
public IDeviceManager DeviceManager { get; }
Property Value
Type Description
IDeviceManager
View Source

Logger

Gets the Phoenix logger.

Declaration
public IPhoenixLogger Logger { get; }
Property Value
Type Description
IPhoenixLogger

Methods

View Source

GetDeviceDisplayName(String)

Get the device display name based on the ip address.

Declaration
public string GetDeviceDisplayName(string ipAddress)
Parameters
Type Name Description
System.String ipAddress

The ip of the device the game is running on.
Returns
Type Description
System.String

The device display name.
View Source

GetDeviceTypeName(String)

Get the device type name based on the ip address.

Declaration
public string GetDeviceTypeName(string ipAddress)
Parameters
Type Name Description
System.String ipAddress

The ip of the device the game is running on.
Returns
Type Description
System.String

The device type name.
View Source

LogToPhoenix(String, Object[])

Writes a log to the Phoenix console.

Declaration
public void LogToPhoenix(string entry, params object[] parameters)
Parameters
Type Name Description
System.String entry

The log entry.
System.Object[] parameters

The parameters to write into the log entry.
View Source

SendPolarisRequests(String, String, List<PhoenixRequestBase>)

Sends Polaris recommendation requests.

Declaration
public void SendPolarisRequests(string titleName, string ipAddress, List<PhoenixRequestBase> requests)
Parameters
Type Name Description
System.String titleName

The name of the game these requests are for.
System.String ipAddress

The ip of the device.
System.Collections.Generic.List<PhoenixRequestBase> requests

A list of requests to send.