Modification filter for use by ServiceMods. More...
Classes | |
| enum | MatureContent |
| Mature content filter value. More... | |
| enum | Revenue |
| Revenue filter value. More... | |
| enum | SortField |
| Field to use for sorting modifications. More... | |
Public Member Functions | |
| ServiceModFilter | new () |
| Create new instance of ServiceModFilter. More... | |
| ServiceModFilter | new (ServiceModFilter filter) |
| Create copy of ServiceModFilter. More... | |
Public Attributes | |
| bool | disallowMatureContent |
| Exclude modifications with mature content. More... | |
| Set | matchingAuthor |
| Filter by author user identifier matching one or more identifiers. More... | |
| Set | matchingName |
| Filter by name matching one or more strings. More... | |
| String | metadataLike |
| Filter by meta data containing string. More... | |
| TimeDate | releasedAfter |
| Filter by modifications released after a specific time. More... | |
| TimeDate | releasedBefore |
| Filter by modifications released before a specific time. More... | |
| int | resultCount |
| Count of result to show. More... | |
| Revenue | revenueType |
| Filter by revenue type. More... | |
| SortField | sortField |
| Field to sort modifications. More... | |
| int | startIndex |
| Index of first filter result to show. More... | |
| Set | withIds |
| Filter by modification identifier matching one or more identifiers. More... | |
| Set | withMatureContentFlags |
| Filter by maturity content flags matching one or more flags. More... | |
| Set | withoutIds |
| Filter by modification identifier not matching identifiers. More... | |
| Set | withoutTags |
| Filter by tag not matching any tags. More... | |
| Set | withTags |
| Filter by tag matching one or more tags. More... | |
Detailed Description
Modification filter for use by ServiceMods.
- Version
- 1.23
Member Function Documentation
◆ new() [1/2]
| ServiceModFilter Dragengine.Services.Mods.ServiceModFilter.new | ( | ) |
Create new instance of ServiceModFilter.
◆ new() [2/2]
| ServiceModFilter Dragengine.Services.Mods.ServiceModFilter.new | ( | ServiceModFilter | filter | ) |
Create copy of ServiceModFilter.
Member Data Documentation
◆ disallowMatureContent
| bool Dragengine.Services.Mods.ServiceModFilter.disallowMatureContent |
◆ matchingAuthor
| Set Dragengine.Services.Mods.ServiceModFilter.matchingAuthor |
Filter by author user identifier matching one or more identifiers.
Set contains user identifiers as String instance.
Use null to not filter by author user identifier.
Supported by:
◆ matchingName
| Set Dragengine.Services.Mods.ServiceModFilter.matchingName |
Filter by name matching one or more strings.
Set contains String names.
Use null to not filter by name.
Supported by:
◆ metadataLike
| String Dragengine.Services.Mods.ServiceModFilter.metadataLike |
Filter by meta data containing string.
Use null to not filter by meta data.
Supported by:
◆ releasedAfter
| TimeDate Dragengine.Services.Mods.ServiceModFilter.releasedAfter |
Filter by modifications released after a specific time.
Use null to not filter by release date.
Supported by:
◆ releasedBefore
| TimeDate Dragengine.Services.Mods.ServiceModFilter.releasedBefore |
Filter by modifications released before a specific time.
Use null to not filter by release date.
Supported by:
◆ resultCount
| int Dragengine.Services.Mods.ServiceModFilter.resultCount |
Count of result to show.
Invalid values are potentially clamped or result in request failure. Use 0 for default value as governed by the used service provider.
Supported by:
- ServiceModio. Maximum allowed value 100.
◆ revenueType
| Revenue Dragengine.Services.Mods.ServiceModFilter.revenueType |
◆ sortField
| SortField Dragengine.Services.Mods.ServiceModFilter.sortField |
Field to sort modifications.
Use null to sort by the default field as defined by the service module.
Supported by:
◆ startIndex
| int Dragengine.Services.Mods.ServiceModFilter.startIndex |
Index of first filter result to show.
Invalid values are potentially clamped or result in request failure.
Supported by:
- ServiceModio: Minimum allowed value 0.
◆ withIds
| Set Dragengine.Services.Mods.ServiceModFilter.withIds |
Filter by modification identifier matching one or more identifiers.
Set contains modification identifiers as String instance.
Use null to not filter by modification identifier.
Supported by:
◆ withMatureContentFlags
| Set Dragengine.Services.Mods.ServiceModFilter.withMatureContentFlags |
Filter by maturity content flags matching one or more flags.
Set contains ServiceModFilterMatureContent constants.
Use null to not filter by mature content.
Supported by:
◆ withoutIds
| Set Dragengine.Services.Mods.ServiceModFilter.withoutIds |
Filter by modification identifier not matching identifiers.
Set contains modification identifiers as String instance.
Use null to not filter by modification identifier.
Supported by:
◆ withoutTags
| Set Dragengine.Services.Mods.ServiceModFilter.withoutTags |
Filter by tag not matching any tags.
Set contains tags as String instance.
Use null to not filter by tags.
Supported by:
◆ withTags
| Set Dragengine.Services.Mods.ServiceModFilter.withTags |
Filter by tag matching one or more tags.
Set contains tags as String instance.
Use null to not filter by tags.
Supported by:
The documentation for this class was generated from the following file:
