Class: BrickFTP::Types::Notification

Inherits:
Struct
  • Object
show all
Includes:
IgnoreUndefinedAttributes
Defined in:
lib/brick_ftp/types/notification.rb

Overview

The notification object

ATTRIBUTE TYPE DESCRIPTION
id integer Globally unique identifier of each notification. Each notification is given an ID automatically upon creation.
path string Folder path for notifications. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
user_id integer Unique identifier for the user being notified. Each user is given an ID automatically upon creation. You can look up user IDs by using the User resource of this REST API.
username string Username for the user given by user_id. If this value is set during creation and user_id is not set, the user_id is looked up from the username and set. Maximum of 50 characters.
send_interval string The send interval for notifications. Can be one of the following: five_minutes (default), fifteen_minutes, hourly, daily.
unsubscribed boolean If true, the user has unsubscribed from receiving this notification. This property is read-only.

See Also:

Instance Attribute Summary collapse

Method Summary

Methods included from IgnoreUndefinedAttributes

#initialize

Instance Attribute Details

#id ⇒ Object

Returns the value of attribute id

Returns:

  • (Object) —

    the current value of id



20
21
22
 
# File 'lib/brick_ftp/types/notification.rb', line 20

def id
  @id
end

#path ⇒ Object

Returns the value of attribute path

Returns:

  • (Object) —

    the current value of path



20
21
22
 
# File 'lib/brick_ftp/types/notification.rb', line 20

def path
  @path
end

#send_interval ⇒ Object

Returns the value of attribute send_interval

Returns:

  • (Object) —

    the current value of send_interval



20
21
22
 
# File 'lib/brick_ftp/types/notification.rb', line 20

def send_interval
  @send_interval
end

#unsubscribed ⇒ Object

Returns the value of attribute unsubscribed

Returns:

  • (Object) —

    the current value of unsubscribed



20
21
22
 
# File 'lib/brick_ftp/types/notification.rb', line 20

def unsubscribed
  @unsubscribed
end

#user_id ⇒ Object

Returns the value of attribute user_id

Returns:

  • (Object) —

    the current value of user_id



20
21
22
 
# File 'lib/brick_ftp/types/notification.rb', line 20

def user_id
  @user_id
end

#username ⇒ Object

Returns the value of attribute username

Returns:

  • (Object) —

    the current value of username



20
21
22
 
# File 'lib/brick_ftp/types/notification.rb', line 20

def username
  @username
end