td::td_api::cleanFileName Class Reference

Inherits td::td_api::Function.

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

Public Member Functions
	cleanFileName ()
	cleanFileName (string const &file_name_)
std::int32_t	get_id () const final
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
TlObject &	operator= (const TlObject &)=delete
	TlObject (TlObject &&)=default
TlObject &	operator= (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. The encoding of the file name is supposed to be UTF-8. Returns an empty string on failure. Can be called synchronously.

Returns object_ptr<Text>.

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. The encoding of the file name is supposed to be UTF-8. 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. The encoding of the file name is supposed to be UTF-8. 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

get_id()

std::int32_t td::td_api::cleanFileName::get_id ( ) const

inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns

this->ID.

Implements td::TlObject.

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]	s	Storer to which object string representation will be appended.
[in]	field_name	Object field_name if applicable.

Implements td::TlObject.

---

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

• td/generate/auto/td/telegram/td_api.h