tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
td::td_api::cleanFileName Class Referencefinal

#include </home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h>

Inheritance diagram for td::td_api::cleanFileName:
td::td_api::Function td::TlObject

Public Types

using ReturnType = object_ptr< text >
 Typedef for the type returned by the function.
 

Public Member Functions

 cleanFileName ()
 
 cleanFileName (string const &file_name_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Member Functions inherited from td::TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Public Attributes

string file_name_
 File name or path to the file.
 

Static Public Attributes

static const std::int32_t ID = 967964667
 Identifier uniquely determining a type of the object.
 

Detailed Description

Removes potentially dangerous characters from the name of a file. Returns an empty string on failure. Can be called synchronously.

Returns object_ptr<Text>.

Definition at line 92010 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 92043 of file td_api.h.

Constructor & Destructor Documentation

◆ cleanFileName() [1/2]

td::td_api::cleanFileName::cleanFileName ( )

Default constructor for a function, which removes potentially dangerous characters from the name of a file. Returns an empty string on failure. Can be called synchronously.

Returns object_ptr<Text>.

◆ cleanFileName() [2/2]

td::td_api::cleanFileName::cleanFileName ( string const &  file_name_)
explicit

Creates a function, which removes potentially dangerous characters from the name of a file. Returns an empty string on failure. Can be called synchronously.

Returns object_ptr<Text>.

Parameters
[in]file_name_File name or path to the file.

Member Function Documentation

◆ store()

void td::td_api::cleanFileName::store ( TlStorerToString &  s,
const char *  field_name 
) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements td::TlObject.

Member Data Documentation

◆ file_name_

string td::td_api::cleanFileName::file_name_

File name or path to the file.

Definition at line 92021 of file td_api.h.

◆ ID

const std::int32_t td::td_api::cleanFileName::ID = 967964667
static

Identifier uniquely determining a type of the object.

Definition at line 92040 of file td_api.h.


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