on_link_list Event

This event fires once for each link returned when ListLinks or GetLinkInfo is called.

Syntax

class ShareFileLinkListEventParams(object):
  @property
  def id() -> str: ...
  @property
  def title() -> str: ...
  @property
  def url() -> str: ...
  @property
  def link_type() -> int: ...
  @property
  def access_level() -> int: ...
  @property
  def expiration_date() -> str: ...
  @property
  def creation_date() -> str: ...
  @property
  def is_view_only() -> bool: ...
  @property
  def max_downloads() -> int: ...
  @property
  def total_downloads() -> int: ...
  @property
  def notify_on_access() -> bool: ...

# In class ShareFile:
@property
def on_link_list() -> Callable[[ShareFileLinkListEventParams], None]: ...
@on_link_list.setter
def on_link_list(event_hook: Callable[[ShareFileLinkListEventParams], None]) -> None: ...

Remarks

This event fires once for each link returned when list_links or get_link_info is called. The link cannot be modified from this event. This event will not show the items related to the specific link when calling list_link_items. Those will be listed using the on_item_list event.