Skip to content

PikaCore

Contents

ApiAuthController type

Namespace

PikaCore.Areas.Api.v1.Controllers

Summary

This class is responsible for user authorization process. It is Federation aware.

#ctor(authService) constructor

Summary

Just a default constructor, it is used only by a DI, should NOT be used by a developer.

Parameters
Name Type Description
authService PikaCore.Areas.Api.v1.Services.IAuthService

Authenticate(user) method

Summary
Returns
Parameters
Name Type Description
user PikaCore.Areas.Api.v1.Models.ApiUser

SignOut() method

Summary
Returns
Parameters

This method has no parameters.

ApiMessage`1 type

Namespace

PikaCore.Areas.Api.v1.Models

Summary

Represents object returned by any one endpoint presented by the API to user.

Generic Types
Name Description
T

Data property

Summary

Represents actual data for which user asked.

Messages property

Summary

Additional, mainly server messages; those are important in case there is some problem on server's side and Data field is null.'

Status property

Summary

Boolean value indicating if the request was processed successfully or not.

AddMessage(message) method

Summary
Parameters
Name Type Description
message System.String

GetLastAddedMessage() method

Summary
Returns
Parameters

This method has no parameters.

GetMessages() method

Summary
Returns
Parameters

This method has no parameters.

ApiUser type

Namespace

PikaCore.Areas.Api.v1.Models

Summary

This class represents a user of PikaCloud.

Password property

Summary

String value representing user's password.'

Username property

Summary

String value representing user's username.'

IPayload`1 type

Namespace

PikaCore.Areas.Api.v1.Models

Summary
Generic Types
Name Description
T

AddMessage(message) method

Summary

Adds message to a message stack.

Parameters
Name Type Description
message System.String

GetLastAddedMessage() method

Summary

Returns last added message.

Returns
Parameters

This method has no parameters.

GetMessages() method

Summary

Returns all messages as a Stack.

Returns
Parameters

This method has no parameters.

MessageDto type

Namespace

PikaCore.Areas.Api.v1.Models.DTO

CreatedAt property

Summary

Id property

Summary

Message property

Summary

MessageType property

Summary

RelatedIssues property

Summary

UpdatedAt property

Summary

FromMessageEntity(e) method

Summary
Returns
Parameters
Name Type Description
e PikaCore.Areas.Infrastructure.Data.MessageEntity

Resources type

Namespace

PikaCore.Properties

Summary

A strongly-typed resource class, for looking up localized strings, etc.

Culture property

Summary

Overrides the current thread's CurrentUICulture property for all resource lookups using this strongly typed resource class.

ResourceManager property

Summary

Returns the cached ResourceManager instance used by this class.

Startup_ConfigureServices_Logger_output___0_ property

Summary

Looks up a localized string similar to Logger output: {0}.

Startup_OnStart_System_is_starting___ property

Summary

Looks up a localized string similar to System is starting....

RestApiController type

Namespace

PikaCore.Areas.Api.v1.Controllers

Summary

Index() method

Summary

Just an index action of API. It will always return HTTP 200 OK, it can be used for checking if API is up.

Returns
Parameters

This method has no parameters.

NotFoundHandler() method

Summary

Not used at the moment.

Returns
Parameters

This method has no parameters.

StatusController type

Namespace

PikaCore.Areas.Api.v1.Controllers

Summary

Status endpoint, presents some detailed information about PikaCloud status. Data format: JSON

#ctor(messageService,statusService,systemService) constructor

Summary

Just a default constructor used by DI.

Parameters
Name Type Description
messageService PikaCore.Areas.Infrastructure.Services.IMessageService
statusService PikaCore.Areas.Api.v1.Services.IStatusService
systemService PikaCore.Areas.Infrastructure.Services.ISystemService

Index() method

Summary

Returns standard object. Data field will contain string, which is a human readable message about PikaCloud status.

Returns
Parameters

This method has no parameters.

Issues(systemName,order,count,offset) method

Summary

Returns standard object. Data field contains object of IList interface of type IssueEntity.

Returns
Parameters
Name Type Description
systemName System.String String which identifies public system in PikaCloud.
order System.Int32 Integer value which indicates as follows - 0 is ASC order, 1 is DESC order. Default is 0.
count System.Int32 Integer value which indicates how many issues should be returned. Default is 10.
offset System.Int32 Integer value which indicates from which issue we want start to read issues. Default is 0.

MessageById(id) method

Summary

Returns standard object. Data field will contain MessageDto object.

Returns
Parameters
Name Type Description
id System.Int32

Messages(systemName,order,count,offset) method

Summary

Returns standard object. Data field contains object of IList interface of type MessageDto.

Returns
Parameters
Name Type Description
systemName System.String String which identifies public system in PikaCloud.
order System.Int32 Integer value which indicates as follows - 0 is ASC order, 1 is DESC order. Default is 0.
count System.Int32 Integer value which indicates how many messages should be returned. Default is 10.
offset System.Int32 Integer value which indicates from which message we want start to read messages. Default is 0.

MessagesByDateCreated(from,to,order) method

Summary

Redirects to /messages.

Returns
Parameters
Name Type Description
from System.DateTime
to System.DateTime
order System.Int32

SystemTextState(systemName) method

Summary
Returns
Parameters
Name Type Description
systemName System.String

Systems() method

Summary
Returns
Parameters

This method has no parameters.