Skip to content

RHAPI_InventoryPageMeta

Summary

MembersDescriptions
struct FRHAPI_InventoryPageMetaMetadata about the page of results.

struct FRHAPI_InventoryPageMeta

struct FRHAPI_InventoryPageMeta
: public FRHAPI_Model

Metadata about the page of results.

Summary

MembersDescriptions
public FDateTime StartingPosition_OptionalDatetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.
public bool StartingPosition_IsSettrue if StartingPosition_Optional has been set to a value
public FString Cursor_OptionalThe cursor value pointing to the next page of results. If cursor is provided, starting_position is ignored.
public bool Cursor_IsSettrue if Cursor_Optional has been set to a value
public ERHAPI_SortOrder Sort_OptionalThe direction to search.
public bool Sort_IsSettrue if Sort_Optional has been set to a value
public int32 Limit_OptionalThe number of Orders to return.
public bool Limit_IsSettrue if Limit_Optional has been set to a value
public virtual bool FromJson(const TSharedPtr< FJsonValue > & JsonValue)Fills this object with data from the passed in JSON.
public virtual void WriteJson(TSharedRef< TJsonWriter<>> & Writer) constWrites the data from this object into the specified JSON Writer stream.
public inline FDateTime & GetStartingPosition()Gets the value of StartingPosition_Optional, regardless of it having been set.
public inline const FDateTime & GetStartingPosition() constGets the value of StartingPosition_Optional, regardless of it having been set.
public inline const FDateTime & GetStartingPosition(const FDateTime & DefaultValue) constGets the value of StartingPosition_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetStartingPosition(FDateTime & OutValue) constFills OutValue with the value of StartingPosition_Optional and returns true if it has been set, otherwise returns false.
public inline FDateTime * GetStartingPositionOrNull()Returns a pointer to StartingPosition_Optional, if it has been set, otherwise returns nullptr.
public inline const FDateTime * GetStartingPositionOrNull() constReturns a pointer to StartingPosition_Optional, if it has been set, otherwise returns nullptr.
public inline void SetStartingPosition(FDateTime NewValue)Sets the value of StartingPosition_Optional and also sets StartingPosition_IsSet to true.
public inline void ClearStartingPosition()Clears the value of StartingPosition_Optional and sets StartingPosition_IsSet to false.
public inline FString & GetCursor()Gets the value of Cursor_Optional, regardless of it having been set.
public inline const FString & GetCursor() constGets the value of Cursor_Optional, regardless of it having been set.
public inline const FString & GetCursor(const FString & DefaultValue) constGets the value of Cursor_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetCursor(FString & OutValue) constFills OutValue with the value of Cursor_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetCursorOrNull()Returns a pointer to Cursor_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetCursorOrNull() constReturns a pointer to Cursor_Optional, if it has been set, otherwise returns nullptr.
public inline void SetCursor(FString NewValue)Sets the value of Cursor_Optional and also sets Cursor_IsSet to true.
public inline void ClearCursor()Clears the value of Cursor_Optional and sets Cursor_IsSet to false.
public inline ERHAPI_SortOrder & GetSort()Gets the value of Sort_Optional, regardless of it having been set.
public inline const ERHAPI_SortOrder & GetSort() constGets the value of Sort_Optional, regardless of it having been set.
public inline const ERHAPI_SortOrder & GetSort(const ERHAPI_SortOrder & DefaultValue) constGets the value of Sort_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetSort(ERHAPI_SortOrder & OutValue) constFills OutValue with the value of Sort_Optional and returns true if it has been set, otherwise returns false.
public inline ERHAPI_SortOrder * GetSortOrNull()Returns a pointer to Sort_Optional, if it has been set, otherwise returns nullptr.
public inline const ERHAPI_SortOrder * GetSortOrNull() constReturns a pointer to Sort_Optional, if it has been set, otherwise returns nullptr.
public inline void SetSort(ERHAPI_SortOrder NewValue)Sets the value of Sort_Optional and also sets Sort_IsSet to true.
public inline void ClearSort()Clears the value of Sort_Optional and sets Sort_IsSet to false.
public inline int32 & GetLimit()Gets the value of Limit_Optional, regardless of it having been set.
public inline const int32 & GetLimit() constGets the value of Limit_Optional, regardless of it having been set.
public inline const int32 & GetLimit(const int32 & DefaultValue) constGets the value of Limit_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetLimit(int32 & OutValue) constFills OutValue with the value of Limit_Optional and returns true if it has been set, otherwise returns false.
public inline int32 * GetLimitOrNull()Returns a pointer to Limit_Optional, if it has been set, otherwise returns nullptr.
public inline const int32 * GetLimitOrNull() constReturns a pointer to Limit_Optional, if it has been set, otherwise returns nullptr.
public inline void SetLimit(int32 NewValue)Sets the value of Limit_Optional and also sets Limit_IsSet to true.
public inline void ClearLimit()Clears the value of Limit_Optional and sets Limit_IsSet to false.
public inline bool IsLimitDefaultValue() constReturns true if Limit_Optional is set and matches the default value.
public inline void SetLimitToDefault()Sets the value of Limit_Optional to its default and also sets Limit_IsSet to true.

Members

public FDateTime StartingPosition_Optional

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone.

public bool StartingPosition_IsSet

true if StartingPosition_Optional has been set to a value

public FString Cursor_Optional

The cursor value pointing to the next page of results. If cursor is provided, starting_position is ignored.

public bool Cursor_IsSet

true if Cursor_Optional has been set to a value

public ERHAPI_SortOrder Sort_Optional

The direction to search.

public bool Sort_IsSet

true if Sort_Optional has been set to a value

public int32 Limit_Optional

The number of Orders to return.

public bool Limit_IsSet

true if Limit_Optional has been set to a value

public virtual bool FromJson(const TSharedPtr< FJsonValue > & JsonValue)

Fills this object with data from the passed in JSON.

Parameters

  • JsonValue Data from the API call.

Returns

true if parsing of the JSON data was successful.

public virtual void WriteJson(TSharedRef< TJsonWriter<>> & Writer) const

Writes the data from this object into the specified JSON Writer stream.

Parameters

  • Writer JSON Writer stream to push .

public inline FDateTime & GetStartingPosition()

Gets the value of StartingPosition_Optional, regardless of it having been set.

public inline const FDateTime & GetStartingPosition() const

Gets the value of StartingPosition_Optional, regardless of it having been set.

public inline const FDateTime & GetStartingPosition(const FDateTime & DefaultValue) const

Gets the value of StartingPosition_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetStartingPosition(FDateTime & OutValue) const

Fills OutValue with the value of StartingPosition_Optional and returns true if it has been set, otherwise returns false.

public inline FDateTime * GetStartingPositionOrNull()

Returns a pointer to StartingPosition_Optional, if it has been set, otherwise returns nullptr.

public inline const FDateTime * GetStartingPositionOrNull() const

Returns a pointer to StartingPosition_Optional, if it has been set, otherwise returns nullptr.

public inline void SetStartingPosition(FDateTime NewValue)

Sets the value of StartingPosition_Optional and also sets StartingPosition_IsSet to true.

public inline void ClearStartingPosition()

Clears the value of StartingPosition_Optional and sets StartingPosition_IsSet to false.

public inline FString & GetCursor()

Gets the value of Cursor_Optional, regardless of it having been set.

public inline const FString & GetCursor() const

Gets the value of Cursor_Optional, regardless of it having been set.

public inline const FString & GetCursor(const FString & DefaultValue) const

Gets the value of Cursor_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetCursor(FString & OutValue) const

Fills OutValue with the value of Cursor_Optional and returns true if it has been set, otherwise returns false.

public inline FString * GetCursorOrNull()

Returns a pointer to Cursor_Optional, if it has been set, otherwise returns nullptr.

public inline const FString * GetCursorOrNull() const

Returns a pointer to Cursor_Optional, if it has been set, otherwise returns nullptr.

public inline void SetCursor(FString NewValue)

Sets the value of Cursor_Optional and also sets Cursor_IsSet to true.

public inline void ClearCursor()

Clears the value of Cursor_Optional and sets Cursor_IsSet to false.

public inline ERHAPI_SortOrder & GetSort()

Gets the value of Sort_Optional, regardless of it having been set.

public inline const ERHAPI_SortOrder & GetSort() const

Gets the value of Sort_Optional, regardless of it having been set.

public inline const ERHAPI_SortOrder & GetSort(const ERHAPI_SortOrder & DefaultValue) const

Gets the value of Sort_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetSort(ERHAPI_SortOrder & OutValue) const

Fills OutValue with the value of Sort_Optional and returns true if it has been set, otherwise returns false.

public inline ERHAPI_SortOrder * GetSortOrNull()

Returns a pointer to Sort_Optional, if it has been set, otherwise returns nullptr.

public inline const ERHAPI_SortOrder * GetSortOrNull() const

Returns a pointer to Sort_Optional, if it has been set, otherwise returns nullptr.

public inline void SetSort(ERHAPI_SortOrder NewValue)

Sets the value of Sort_Optional and also sets Sort_IsSet to true.

public inline void ClearSort()

Clears the value of Sort_Optional and sets Sort_IsSet to false.

public inline int32 & GetLimit()

Gets the value of Limit_Optional, regardless of it having been set.

public inline const int32 & GetLimit() const

Gets the value of Limit_Optional, regardless of it having been set.

public inline const int32 & GetLimit(const int32 & DefaultValue) const

Gets the value of Limit_Optional, if it has been set, otherwise it returns DefaultValue.

public inline bool GetLimit(int32 & OutValue) const

Fills OutValue with the value of Limit_Optional and returns true if it has been set, otherwise returns false.

public inline int32 * GetLimitOrNull()

Returns a pointer to Limit_Optional, if it has been set, otherwise returns nullptr.

public inline const int32 * GetLimitOrNull() const

Returns a pointer to Limit_Optional, if it has been set, otherwise returns nullptr.

public inline void SetLimit(int32 NewValue)

Sets the value of Limit_Optional and also sets Limit_IsSet to true.

public inline void ClearLimit()

Clears the value of Limit_Optional and sets Limit_IsSet to false.

public inline bool IsLimitDefaultValue() const

Returns true if Limit_Optional is set and matches the default value.

public inline void SetLimitToDefault()

Sets the value of Limit_Optional to its default and also sets Limit_IsSet to true.