Class ResultBase

• Defined in File WebService.h

Inheritance Relationships

Derived Types

• public csp::multiplayer::AnnotationResult (Class AnnotationResult)

• public csp::multiplayer::AnnotationThumbnailCollectionResult (Class AnnotationThumbnailCollectionResult)

• public csp::multiplayer::ConversationResult (Class ConversationResult)

• public csp::multiplayer::MessageCollectionResult (Class MessageCollectionResult)

• public csp::multiplayer::MessageResult (Class MessageResult)

• public csp::multiplayer::NumberOfRepliesResult (Class NumberOfRepliesResult)

• public csp::systems::AcceptedInvitesResult (Class AcceptedInvitesResult)

• public csp::systems::AddShopifyStoreResult (Class AddShopifyStoreResult)

• public csp::systems::AnchorCollectionResult (Class AnchorCollectionResult)

• public csp::systems::AnchorResolutionCollectionResult (Class AnchorResolutionCollectionResult)

• public csp::systems::AnchorResolutionResult (Class AnchorResolutionResult)

• public csp::systems::AnchorResult (Class AnchorResult)

• public csp::systems::ApplicationSettingsResult (Class ApplicationSettingsResult)

• public csp::systems::AssetCollectionCountResult (Class AssetCollectionCountResult)

• public csp::systems::AssetCollectionResult (Class AssetCollectionResult)

• public csp::systems::AssetCollectionsResult (Class AssetCollectionsResult)

• public csp::systems::AssetDataResult (Class AssetDataResult)

• public csp::systems::AssetResult (Class AssetResult)

• public csp::systems::AssetsResult (Class AssetsResult)

• public csp::systems::AvatarInfoResult (Class AvatarInfoResult)

• public csp::systems::BasicProfilesResult (Class BasicProfilesResult)

• public csp::systems::BasicSpaceResult (Class BasicSpaceResult)

• public csp::systems::BasicSpacesResult (Class BasicSpacesResult)

• public csp::systems::BooleanResult (Class BooleanResult)

• public csp::systems::CartInfoResult (Class CartInfoResult)

• public csp::systems::CheckoutInfoResult (Class CheckoutInfoResult)

• public csp::systems::EventTicketResult (Class EventTicketResult)

• public csp::systems::FeatureLimitResult (Class FeatureLimitResult)

• public csp::systems::FeatureQuotaResult (Class FeatureQuotaResult)

• public csp::systems::FeaturesLimitResult (Class FeaturesLimitResult)

• public csp::systems::FeaturesQuotaResult (Class FeaturesQuotaResult)

• public csp::systems::GetShopifyStoresResult (Class GetShopifyStoresResult)

• public csp::systems::GraphQLResult (Class GraphQLResult)

• public csp::systems::HTTPHeadersResult (Class HTTPHeadersResult)

• public csp::systems::HotspotGroupResult (Class HotspotGroupResult)

• public csp::systems::HotspotGroupsResult (Class HotspotGroupsResult)

• public csp::systems::LODChainResult (Class LODChainResult)

• public csp::systems::LoginStateResult (Class LoginStateResult)

• public csp::systems::LoginTokenInfoResult (Class LoginTokenInfoResult)

• public csp::systems::MaintenanceInfoResult (Class MaintenanceInfoResult)

• public csp::systems::MaterialResult (Class MaterialResult)

• public csp::systems::MaterialsResult (Class MaterialsResult)

• public csp::systems::NullResult (Class NullResult)

• public csp::systems::POICollectionResult (Class POICollectionResult)

• public csp::systems::POIResult (Class POIResult)

• public csp::systems::PendingInvitesResult (Class PendingInvitesResult)

• public csp::systems::ProductInfoCollectionResult (Class ProductInfoCollectionResult)

• public csp::systems::ProductInfoResult (Class ProductInfoResult)

• public csp::systems::ProfileResult (Class ProfileResult)

• public csp::systems::ProviderDetailsResult (Class ProviderDetailsResult)

• public csp::systems::SequenceResult (Class SequenceResult)

• public csp::systems::SequencesResult (Class SequencesResult)

• public csp::systems::ServicesDeploymentStatusResult (Class ServicesDeploymentStatusResult)

• public csp::systems::SettingsCollectionResult (Class SettingsCollectionResult)

• public csp::systems::SiteResult (Class SiteResult)

• public csp::systems::SitesCollectionResult (Class SitesCollectionResult)

• public csp::systems::SpaceGeoLocationCollectionResult (Class SpaceGeoLocationCollectionResult)

• public csp::systems::SpaceGeoLocationResult (Class SpaceGeoLocationResult)

• public csp::systems::SpaceIsTicketedResult (Class SpaceIsTicketedResult)

• public csp::systems::SpaceMetadataResult (Class SpaceMetadataResult)

• public csp::systems::SpaceResult (Class SpaceResult)

• public csp::systems::SpacesMetadataResult (Class SpacesMetadataResult)

• public csp::systems::SpacesResult (Class SpacesResult)

• public csp::systems::StringArrayResult (Class StringArrayResult)

• public csp::systems::StringResult (Class StringResult)

• public csp::systems::TicketedEventCollectionResult (Class TicketedEventCollectionResult)

• public csp::systems::TicketedEventResult (Class TicketedEventResult)

• public csp::systems::TicketedEventVendorAuthInfoResult (Class TicketedEventVendorAuthInfoResult)

• public csp::systems::UInt64Result (Class UInt64Result)

• public csp::systems::UriResult (Class UriResult)

• public csp::systems::UserRoleCollectionResult (Class UserRoleCollectionResult)

• public csp::systems::UserTierResult (Class UserTierResult)

• public csp::systems::ValidateShopifyStoreResult (Class ValidateShopifyStoreResult)

Class Documentation

class ResultBase

Base class for a HTTP request result.

Subclassed by csp::multiplayer::AnnotationResult, csp::multiplayer::AnnotationThumbnailCollectionResult, csp::multiplayer::ConversationResult, csp::multiplayer::MessageCollectionResult, csp::multiplayer::MessageResult, csp::multiplayer::NumberOfRepliesResult, csp::systems::AcceptedInvitesResult, csp::systems::AddShopifyStoreResult, csp::systems::AnchorCollectionResult, csp::systems::AnchorResolutionCollectionResult, csp::systems::AnchorResolutionResult, csp::systems::AnchorResult, csp::systems::ApplicationSettingsResult, csp::systems::AssetCollectionCountResult, csp::systems::AssetCollectionResult, csp::systems::AssetCollectionsResult, csp::systems::AssetDataResult, csp::systems::AssetResult, csp::systems::AssetsResult, csp::systems::AvatarInfoResult, csp::systems::BasicProfilesResult, csp::systems::BasicSpaceResult, csp::systems::BasicSpacesResult, csp::systems::BooleanResult, csp::systems::CartInfoResult, csp::systems::CheckoutInfoResult, csp::systems::EventTicketResult, csp::systems::FeatureLimitResult, csp::systems::FeatureQuotaResult, csp::systems::FeaturesLimitResult, csp::systems::FeaturesQuotaResult, csp::systems::GetShopifyStoresResult, csp::systems::GraphQLResult, csp::systems::HTTPHeadersResult, csp::systems::HotspotGroupResult, csp::systems::HotspotGroupsResult, csp::systems::LODChainResult, csp::systems::LoginStateResult, csp::systems::LoginTokenInfoResult, csp::systems::MaintenanceInfoResult, csp::systems::MaterialResult, csp::systems::MaterialsResult, csp::systems::NullResult, csp::systems::POICollectionResult, csp::systems::POIResult, csp::systems::PendingInvitesResult, csp::systems::ProductInfoCollectionResult, csp::systems::ProductInfoResult, csp::systems::ProfileResult, csp::systems::ProviderDetailsResult, csp::systems::SequenceResult, csp::systems::SequencesResult, csp::systems::ServicesDeploymentStatusResult, csp::systems::SettingsCollectionResult, csp::systems::SiteResult, csp::systems::SitesCollectionResult, csp::systems::SpaceGeoLocationCollectionResult, csp::systems::SpaceGeoLocationResult, csp::systems::SpaceIsTicketedResult, csp::systems::SpaceMetadataResult, csp::systems::SpaceResult, csp::systems::SpacesMetadataResult, csp::systems::SpacesResult, csp::systems::StringArrayResult, csp::systems::StringResult, csp::systems::TicketedEventCollectionResult, csp::systems::TicketedEventResult, csp::systems::TicketedEventVendorAuthInfoResult, csp::systems::UInt64Result, csp::systems::UriResult, csp::systems::UserRoleCollectionResult, csp::systems::UserTierResult, csp::systems::ValidateShopifyStoreResult

Public Functions

ResultBase()

Constructs an empty result.

virtual ~ResultBase() = default

Virtual destructor.

bool operator==(const ResultBase &other) const

bool operator!=(const ResultBase &other) const

virtual void OnProgress(const services::ApiResponseBase *ApiResponse)

Called when progress has been updated.

Parameters

ApiResponse – const ApiResponseBase* : Response received from the request

virtual void OnResponse(const services::ApiResponseBase *ApiResponse)

Called when a response has been received.

Parameters

ApiResponse – const ApiResponseBase* : Response received from the request

EResultCode GetResultCode() const

Status of this response.

Returns

EResultCode

uint16_t GetHttpResultCode() const

Result of http request.

Returns

uint16_t

const csp::common::String &GetResponseBody() const

Body of the response.

float GetRequestProgress() const

Percentage of POST/PUT request completion.

Returns

float

float GetResponseProgress() const

Percentage of GET/HEAD response completion.

Returns

float

ERequestFailureReason GetFailureReason() const

Get a code representing the failure reason, if relevant.

Returns

ERequestFailureReason

Protected Functions

ResultBase(csp::systems::EResultCode ResCode, uint16_t HttpResCode)

ResultBase(csp::systems::EResultCode ResCode, uint16_t HttpResCode, csp::systems::ERequestFailureReason Reason)

void SetResult(csp::systems::EResultCode ResCode, uint16_t HttpResCode)

Protected Attributes

EResultCode Result = EResultCode::Init

uint16_t HttpResponseCode = 0

float RequestProgress = 0.0f

float ResponseProgress = 0.0f

csp::common::String ResponseBody

ERequestFailureReason FailureReason