1 iw4madminapplicationapimaster IMasterApi

RaidMax edited this page 2023-05-20 22:09:21 -05:00

Table of Contents

• IMasterApi Public interface
• Description
• Diagram
• Members
• Properties
• Public properties
• Methods
• Public methods
• Details
• Summary
• Methods
• Authenticate
• Arguments
• AddInstance
• Arguments
• UpdateInstance
• Arguments
• GetVersion
• Arguments
• GetLocalization [1/2]
• GetLocalization [2/2]
• Arguments
• GetPluginSubscription
• Arguments
• Properties
• AuthorizationToken

IMasterApi Public interface

Description

Defines the capabilities of the master API

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph IW4MAdmin.Application.API.Master
  IW4MAdmin.Application.API.Master.IMasterApi[[IMasterApi]]
  class IW4MAdmin.Application.API.Master.IMasterApi interfaceStyle;
  end

Members

Properties

Public properties

Type	Name	Methods
string	AuthorizationToken	get, set

Methods

Public methods

Returns	Name
Task<Response<ResultMessage>>	AddInstance(ApiInstance instance)
Task<TokenId>	Authenticate(AuthenticationId Id)
Task<List<Layout>>	GetLocalization(...)
Task<IEnumerable<PluginSubscriptionContent>>	GetPluginSubscription(Guid instanceId, string subscription_id)
Task<VersionInfo>	GetVersion(int apiVersion)
Task<Response<ResultMessage>>	UpdateInstance(string id, ApiInstance instance)

Details

Summary

Defines the capabilities of the master API

Methods

Authenticate

Source code

public Task<TokenId> Authenticate(AuthenticationId Id)

Arguments

Type	Name	Description
AuthenticationId	Id

AddInstance

Source code

public Task<Response<ResultMessage>> AddInstance(ApiInstance instance)

Arguments

Type	Name	Description
ApiInstance	instance

UpdateInstance

Source code

public Task<Response<ResultMessage>> UpdateInstance(string id, ApiInstance instance)

Arguments

Type	Name	Description
string	id
ApiInstance	instance

GetVersion

Source code

public Task<VersionInfo> GetVersion(int apiVersion)

Arguments

Type	Name	Description
int	apiVersion

GetLocalization [1/2]

Source code

public Task<List<Layout>> GetLocalization()

GetLocalization [2/2]

Source code

public Task<Layout> GetLocalization(string languageTag)

Arguments

Type	Name	Description
string	languageTag

GetPluginSubscription

Source code

public Task<IEnumerable<PluginSubscriptionContent>> GetPluginSubscription(Guid instanceId, string subscription_id)

Arguments

Type	Name	Description
Guid	instanceId
string	subscription_id

Properties

AuthorizationToken

public string AuthorizationToken { get; set; }

Generated with ModularDoc

• Overview
• Getting Started
• FAQ
• Knowledge Base
• Features
  • Commands
  • Webfront
  • Game Interface
  • Permission Sets
  • Plugins
  • API
  • Searching
• Plugin Development
  • Examples
• Configuration
• Game Log Server