rpc

Documentation

Index

• type AddNotificationParams
• type AddNotificationResult
• type AddNotificationSParams
• type AddNotificationSResult
• type AddResourceParams
• type AddResourceResult
• type CountUnreadNotificationsParams
• type CountUnreadNotificationsResult
• type DeleteNotificationParams
• type DeleteNotificationResult
• type DeleteResourceParams
• type DeleteResourceResult
• type GetDKeyParams
• type GetDKeyResult
• type GetListOfAllResourcesOnPageParams
• type GetListOfAllResourcesOnPageResult
• type GetNotificationParams
• type GetNotificationResult
• type GetNotificationsOnPageParams
• type GetNotificationsOnPageResult
• type GetNotificationsParams
• type GetNotificationsResult
• type GetResourceParams
• type GetResourceResult
• type GetResourceValueParams
• type GetResourceValueResult
• type GetUnreadNotificationsParams
• type GetUnreadNotificationsResult
• type MarkNotificationAsReadParams
• type MarkNotificationAsReadResult
• type PingParams
• type PingResult
• type ProcessSystemEventSParams
• type ProcessSystemEventSResult
• type SendNotificationIfPossibleSParams
• type SendNotificationIfPossibleSResult
• type ShowDiagnosticDataParams
• type ShowDiagnosticDataResult
• type TestParams
• type TestResult

Types

type AddNotificationParams

type AddNotificationParams struct {
	rpc2.CommonParams
	UserId base2.Id   `json:"userId"`
	Text   base2.Text `json:"text"`
}

type AddNotificationResult

type AddNotificationResult struct {
	rpc2.CommonResult

	// ID of the created notification.
	NotificationId base2.Id `json:"notificationId"`
}

type AddNotificationSParams

type AddNotificationSParams struct {
	rpc2.CommonParams
	rpc2.DKeyParams
	UserId base2.Id   `json:"userId"`
	Text   base2.Text `json:"text"`
}

type AddNotificationSResult

type AddNotificationSResult struct {
	rpc2.CommonResult

	// ID of the created notification.
	NotificationId base2.Id `json:"notificationId"`
}

type AddResourceParams

type AddResourceParams struct {
	rpc2.CommonParams
	Resource any `json:"resource"`
}

type AddResourceResult

type AddResourceResult struct {
	rpc2.CommonResult

	// ID of the created resource.
	ResourceId base2.Id `json:"resourceId"`
}

type CountUnreadNotificationsParams

type CountUnreadNotificationsParams struct {
	rpc2.CommonParams
}

type CountUnreadNotificationsResult

type CountUnreadNotificationsResult struct {
	rpc2.CommonResult
	UNC base2.Count `json:"unc"`
}

type DeleteNotificationParams

type DeleteNotificationParams struct {
	rpc2.CommonParams
	NotificationId base2.Id `json:"notificationId"`
}

type DeleteNotificationResult

type DeleteNotificationResult = rpc2.CommonResultWithSuccess

type DeleteResourceParams

type DeleteResourceParams struct {
	rpc2.CommonParams
	ResourceId base2.Id `json:"resourceId"`
}

type DeleteResourceResult

type DeleteResourceResult = rpc2.CommonResultWithSuccess

type GetDKeyParams

type GetDKeyParams struct {
	rpc2.CommonParams
}

type GetDKeyResult

type GetDKeyResult struct {
	rpc2.CommonResult
	DKey base2.Text `json:"dKey"`
}

type GetListOfAllResourcesOnPageParams

type GetListOfAllResourcesOnPageParams struct {
	rpc2.CommonParams
	Page base2.Count `json:"page"`
}

type GetListOfAllResourcesOnPageResult

type GetListOfAllResourcesOnPageResult struct {
	rpc2.CommonResult
	ResourcesOnPage *models.ResourcesOnPage `json:"rop"`
}

type GetNotificationParams

type GetNotificationParams struct {
	rpc2.CommonParams
	NotificationId base2.Id `json:"notificationId"`
}

type GetNotificationResult

type GetNotificationResult struct {
	rpc2.CommonResult
	Notification *models.Notification `json:"notification"`
}

type GetNotificationsOnPageParams

type GetNotificationsOnPageParams struct {
	rpc2.CommonParams
	Page base2.Count `json:"page"`
}

type GetNotificationsOnPageResult

type GetNotificationsOnPageResult struct {
	rpc2.CommonResult
	NotificationsOnPage *models.NotificationsOnPage `json:"nop"`
}

type GetNotificationsParams

type GetNotificationsParams struct {
	rpc2.CommonParams
}

type GetNotificationsResult

type GetNotificationsResult struct {
	rpc2.CommonResult
	NotificationIds *ul.UidList           `json:"notificationIds"`
	Notifications   []models.Notification `json:"notifications"`
}

type GetResourceParams

type GetResourceParams struct {
	rpc2.CommonParams
	ResourceId base2.Id `json:"resourceId"`
}

type GetResourceResult

type GetResourceResult struct {
	rpc2.CommonResult
	Resource derived2.IResource `json:"resource"`
}

type GetResourceValueParams

type GetResourceValueParams struct {
	rpc2.CommonParams
	ResourceId base2.Id `json:"resourceId"`
}

type GetResourceValueResult

type GetResourceValueResult struct {
	rpc2.CommonResult
	Resource models.ResourceWithValue `json:"resource"`
}

type GetUnreadNotificationsParams

type GetUnreadNotificationsParams struct {
	rpc2.CommonParams
}

type GetUnreadNotificationsResult

type GetUnreadNotificationsResult struct {
	rpc2.CommonResult
	NotificationIds *ul.UidList           `json:"notificationIds"`
	Notifications   []models.Notification `json:"notifications"`
}

type MarkNotificationAsReadParams

type MarkNotificationAsReadParams struct {
	rpc2.CommonParams

	// Identifier of a notification.
	NotificationId base2.Id `json:"notificationId"`
}

type MarkNotificationAsReadResult

type MarkNotificationAsReadResult = rpc2.CommonResultWithSuccess

type PingParams

type PingParams = rpc2.PingParams

type PingResult

type PingResult = rpc2.PingResult

type ProcessSystemEventSParams

type ProcessSystemEventSParams struct {
	rpc2.CommonParams
	rpc2.DKeyParams
	SystemEventData derived2.ISystemEventData `json:"systemEventData"`
}

type ProcessSystemEventSResult

type ProcessSystemEventSResult = rpc2.CommonResultWithSuccess

type SendNotificationIfPossibleSParams

type SendNotificationIfPossibleSParams struct {
	rpc2.CommonParams
	rpc2.DKeyParams
	UserId base2.Id   `json:"userId"`
	Text   base2.Text `json:"text"`
}

type SendNotificationIfPossibleSResult

type SendNotificationIfPossibleSResult struct {
	rpc2.CommonResult

	// ID and status of the created notification when it is available.
	IsSent         base2.Flag `json:"isSent"`
	NotificationId base2.Id   `json:"notificationId"`
}

type ShowDiagnosticDataParams

type ShowDiagnosticDataParams struct{}

type ShowDiagnosticDataResult

type ShowDiagnosticDataResult struct {
	rpc2.CommonResult
	rpc2.RequestsCount
}

type TestParams

type TestParams struct {
	N uint `json:"n"`
}

type TestResult

type TestResult struct {
	rpc2.CommonResult
}