Shopify SDK for Unity
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Shopify.Unity.ShopifyError Class Reference

A class describing an error that has occurred within the SDK. More...

Inheritance diagram for Shopify.Unity.ShopifyError:
Shopify.Unity.SDK.Serializable

Public Types

enum class  ErrorType { HTTP , GraphQL , UserError , NativePaymentProcessingError }
 Type describing the error in more detail. More...
 

Public Member Functions

 ShopifyError (ErrorType type, string description)
 
override object ToJson ()
 
- Public Member Functions inherited from Shopify.Unity.SDK.Serializable
string ToJsonString ()
 
override string ToString ()
 

Static Public Member Functions

static operator ShopifyError (TopLevelResponse response)
 

Public Attributes

readonly ErrorType Type
 Error type for determining what specific error was encountered. More...
 
readonly string Description
 Readable description of the error. More...
 

Detailed Description

A class describing an error that has occurred within the SDK.

Member Enumeration Documentation

◆ ErrorType

Type describing the error in more detail.

Enumerator
HTTP 

Encountered an HTTP issue or failed connection.

GraphQL 

Encountered an internal GraphQL issue with the API.

UserError 

UserErrors from the GraphQL API. For example, invalid form fields.

NativePaymentProcessingError 

Error while handling payment using a native pay method such as Apple Pay.

Member Data Documentation

◆ Description

readonly string Shopify.Unity.ShopifyError.Description

Readable description of the error.

◆ Type

readonly ErrorType Shopify.Unity.ShopifyError.Type

Error type for determining what specific error was encountered.


The documentation for this class was generated from the following file: