File

class flow_api.file.File(select=None, init=None, by=name, **kwargs)

Base class: Resource

The File class represents a file. Functions from the file class allow interaction with file objects.

A file can be created with system.file('filename').save() inside the handler function of a flow script using the system reference.

Please see https://docs.python.org/3/library/codecs.html#standard-encodings for a list of supported character encodings to specify for the encoding parameter.

See the corresponding Resources class at File

Parameters

Name	Type	Description
**kwargs
by
init
select

Constants

RESOURCE = file

Methods

add_tag (tag)

archive ()

clone (update=None, **kwargs)

delete (permanently=False)

exists ()

export ()

get (*fields, default=None)

get_base64_content ()

get_bytes_content ()

get_dict (*fields, default=None)

get_identity_created_by ()

get_identity_modified_by ()

get_json_content (encoding='utf-8')

get_tags (limit=1000, offset=0, order=None)

get_text_content (encoding='utf-8')

load (*fields)

remove_tag (tag)

restore ()

save (update=None, text=None, bytes_=None, base64_=None, **kwargs)

save_base64_content (base64_)

save_bytes_content (bytes_)

save_json_content (data, encoding='utf-8')

save_text_content (text, encoding='utf-8')

set (key, value)