Class

Struct

Extends:

Includes:

To send structured types across the wire, derive from ActionWebService::Struct, and use member to declare structure members.

ActionWebService::Struct should be used in method signatures when you want to accept or return structured types that have no Active Record model class representations, or you don’t want to expose your entire Active Record model to remote callers.

Example

class Person < ActionWebService::Struct
  member :id,         :int
  member :firstnames, [:string]
  member :lastname,   :string
  member :email,      :string
end
person = Person.new(:id => 5, :firstname => 'john', :lastname => 'doe')

Active Record model classes are already implicitly supported in method signatures.

Public Methods
[] The member with the given name
each_pair Iterates through each member
member Creates a structure member with the specified name and type. Generates accessor methods for reading and writing the member value.
member_type
members
new If a Hash is given as argument to an ActionWebService::Struct constructor, it can contain initial values for the structure member.
Comments

Have your say
Please use Textile formatting (click here for a cheat sheet). Use <code/> and <pre/> for code samples.
Click here to login with OpenID to to post comments.