Skip to content
RallyHere Docs
GitHub

RHAPI_Notes

Summary

MembersDescriptions
struct FRHAPI_NotesNotes to set for the Player’s friend. If you don’t want to modify notes, no not include in body when adding a friend.

struct FRHAPI_Notes

struct FRHAPI_Notes
  : public FRHAPI_Model

Notes to set for the Player’s friend. If you don’t want to modify notes, no not include in body when adding a friend.

Summary

MembersDescriptions
public FString Notes_Optional
public bool Notes_IsSettrue if Notes_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 FString & GetNotes()Gets the value of Notes_Optional, regardless of it having been set.
public inline const FString & GetNotes() constGets the value of Notes_Optional, regardless of it having been set.
public inline const FString & GetNotes(const FString & DefaultValue) constGets the value of Notes_Optional, if it has been set, otherwise it returns DefaultValue.
public inline bool GetNotes(FString & OutValue) constFills OutValue with the value of Notes_Optional and returns true if it has been set, otherwise returns false.
public inline FString * GetNotesOrNull()Returns a pointer to Notes_Optional, if it has been set, otherwise returns nullptr.
public inline const FString * GetNotesOrNull() constReturns a pointer to Notes_Optional, if it has been set, otherwise returns nullptr.
public inline void SetNotes(FString NewValue)Sets the value of Notes_Optional and also sets Notes_IsSet to true.
public inline void ClearNotes()Clears the value of Notes_Optional and sets Notes_IsSet to false.

Members

public FString Notes_Optional


#### `public bool `[`Notes_IsSet`](#structFRHAPI__Notes_1a5f51571b830edca98b4fa43c993bbad1)

true if Notes_Optional has been set to a value


#### `public virtual bool `[`FromJson`](#structFRHAPI__Notes_1a931fbbea1e00ccb16bd4e4689b8d0909)`(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`](#structFRHAPI__Notes_1a629bece73958daf11d8cebb8d65fa7fd)`(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 FString & `[`GetNotes`](#structFRHAPI__Notes_1a46d12e52642cb84d44cb993ca1e342bd)`()`

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


#### `public inline const FString & `[`GetNotes`](#structFRHAPI__Notes_1a03d2bce2d019cd9d78074617683abf97)`() const`

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


#### `public inline const FString & `[`GetNotes`](#structFRHAPI__Notes_1ac09158d85a46f453a940ce679c7d8d7d)`(const FString & DefaultValue) const`

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


#### `public inline bool `[`GetNotes`](#structFRHAPI__Notes_1a13701f221d08e09905879b05bebf8143)`(FString & OutValue) const`

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


#### `public inline FString * `[`GetNotesOrNull`](#structFRHAPI__Notes_1a599ca202519c01a24e5497cf1ef9d060)`()`

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


#### `public inline const FString * `[`GetNotesOrNull`](#structFRHAPI__Notes_1a07d7b8992e4f5231ce1c7cd7d2a3173e)`() const`

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


#### `public inline void `[`SetNotes`](#structFRHAPI__Notes_1a52e0bc03e9c1ff9f9ed51d99272d78ae)`(FString NewValue)`

Sets the value of Notes_Optional and also sets Notes_IsSet to true.


#### `public inline void `[`ClearNotes`](#structFRHAPI__Notes_1ad4213f307363f5dbc56d292b16ef1b65)`()`

Clears the value of Notes_Optional and sets Notes_IsSet to false.