Class WebApiFilters
A collection of WebApiFilter
Namespace: Unity.PSN.PS5.WebApi
Syntax
public class WebApiFiltersConstructors
WebApiFilters()
Default filter constructor
Declaration
public WebApiFilters()WebApiFilters(String[], String, UInt32)
Construct and initialise the filters
Declaration
public WebApiFilters(string[] dataTypes, string serviceName = null, uint serviceLabel = 4294967295U)Parameters
| Type | Name | Description |
|---|---|---|
| String[] | dataTypes | Push Event Data Type |
| String | serviceName | NP service name |
| UInt32 | serviceLabel | NP service label |
Fields
InvalidFilterId
Invalid filter id
Declaration
public const int InvalidFilterId = -1Field Value
| Type | Description |
|---|---|
| Int32 |
Properties
Filters
The collection of filters to use
Declaration
public List<WebApiFilter> Filters { get; set; }Property Value
| Type | Description |
|---|---|
| List<WebApiFilter> |
IsRegistered
Have the filters been registered with the system
Declaration
public bool IsRegistered { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
PushFilterId
PSN Filter ID
Declaration
public int PushFilterId { get; }Property Value
| Type | Description |
|---|---|
| Int32 |
RefCount
Number of PushEvents referencing these filters
Declaration
public uint RefCount { get; }Property Value
| Type | Description |
|---|---|
| UInt32 |
ServiceLabel
Service Label used when register the filters
Declaration
public uint ServiceLabel { get; set; }Property Value
| Type | Description |
|---|---|
| UInt32 |
ServiceName
Service label used when registering the filters
Declaration
public string ServiceName { get; set; }Property Value
| Type | Description |
|---|---|
| String |
Methods
AddFilterParam(String)
Add data type to the filter
Declaration
public WebApiFilter AddFilterParam(string dataType)Parameters
| Type | Name | Description |
|---|---|---|
| String | dataType | The data type string. See DataType |
Returns
| Type | Description |
|---|---|
| WebApiFilter | The filter parameter created from the dataType |
AddFilterParams(String[])
Add an array of data type strings
Declaration
public void AddFilterParams(string[] dataTypes)Parameters
| Type | Name | Description |
|---|---|---|
| String[] | dataTypes | The data type strings. See DataType |
FindFilter(String)
Find a matching filter based on its dataType
Declaration
public WebApiFilter FindFilter(string dataType)Parameters
| Type | Name | Description |
|---|---|---|
| String | dataType | The data type string. See DataType |
Returns
| Type | Description |
|---|---|
| WebApiFilter | The filter parameter matching the dataType or null |