The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Elive::Entity::Preload - Elluminate Preload instance class

DESCRIPTION

This is the entity class for meeting preloads.

    my $preloads = Elive::Entity::Preload->list(
                        filter =>  'mimeType=application/x-shockwave-flash',
                    );

    my $preload = Elive::Entity::Preload->retrieve($preload_id);

    my $type = $preload->type;

There are three possible types of preloads: media, plan and whiteboard.

METHODS

upload

    #
    # upload from a file
    #
    my $preload1 = Elive::Entity::Preload->upload('mypreloads/intro.wbd');

    #
    # upload in-memory data
    #
    my $preload2 = Elive::Entity::Preload->upload(
             {
                    type => 'whiteboard',
                    name => 'introduction.wbd',
                    ownerId => 357147617360,
                    data => $binary_data,
             },
         );

Upload data from a client and create a preload. If a mimeType is not supplied, it will be guessed from the name extension, using MIME::Types.

download

    my $preload = Elive::Entity::Preload->retrieve($preload_id);
    my $binary_data = $preload->download;

Download preload data.

import_from_server

    my $preload1 = Elive::Entity::Preload->import_from_server(
             {
                    type => 'whiteboard',
                    name => 'introduction.wbd',
                    ownerId => 357147617360,
                    fileName => $path_on_server
             },
         );

Create a preload from a file that is already present on the server's file-system. If a mimeType is not supplied, it will be guessed from the name or fileName extension using MIME::Types.

list_meeting_preloads

my $preloads = Elive::Entity::Preload->list_meeting_preloads($meeting_id);

Returns a list of preloads associated with the given meeting-Id or meeting object.

list

   my $all_preloads = Elive::Entity::Preload->list();

Lists all known preloads.

update

The update method is not available for preloads.

BUGS AND LIMITATIONS

  • Under Elluminate 9.6.0 and LDAP, you may need to arbitrarily add a 'DomN:' prefix to the owner ID, when creating or updating a meeting.

        $preload->ownerId('Dom1:freddy');
  • Elluminate 10.0 strips the file extension from the filename when whiteboard files are saved or uploaded (introduction.wbd => introduction). However, if the file lacks an extension to begin with, the request crashes with the confusing error message: "string index out of range: -1".

  • As of ELM 3.3.5, The filter option appears to have no affect when passed to the list() method.