/ 
WWW-Challonge-0.30
River stage zero No dependents
/ WWW::Challonge::Participant

NAME

WWW::Challonge::Participant - A class representing a single participant within a Challonge tournament.

VERSION

Version 0.30

SUBROUTINES/METHODS

new

Takes a hashref representing the participant, the API key and the REST client and turns it into an object. This is mostly used by the module itself, to create a new participant within a tournament see "participant_create" in WWW::Challonge::Tournament.

my $p = WWW::Challonge::Participant->new($participant, $key, $client);

update

Updates specific attributes of a participant. For a full list, see "participant_create" in WWW::Challonge::Tournament. Unlike that method, however, all arguments are optional.

$p->update({
	name => "test2",
	seed => 1
});

check_in

Checks in the participant to the tournament.

$p->check_in;

destroy

If the tournament has not started, deletes the associated participant. If the tournament has started, the participant is marked inactive and their matches are automatically forfeited.

$p->destroy;

# $p still contains the participant, but any future operations will fail:
$p->update({ name => "test2" }); # ERROR!

randomize

Randomises the seeds among participants. Only applicable before a tournament has started. Affects all participants in the tournament.

$p->randomize;

attributes

Gets all the attributes of the participant in hashref and returns it. Contains the following fields.

active
attached_participatable_portrait_url
can_check_in
challonge_email_address_verified
challonge_username
checked_in
checked_in_at
confirm_remove
created_at
display_name_with_invitation_email_address
email_hash
final_rank
group_id
icon
id
invitation_id
invitation_pending
invite_email
misc
name
on_waiting_list
participatable_or_invitation_attached
reactivatable
removable
seed
tournament_id
updated_at
username
my $attr = $p->attributes;
print $attr->{name}, "\n";

__is_kill

Returns an error explaining that the current tournament has been destroyed and returns undef, used so a function doesn't attempt to operate on a tournament that has been successfully destroyed.

__args_are_valid

Checks if the passed arguments and values are valid for creating or updating a tournament.

AUTHOR

Alex Kerr, <kirby at cpan.org>

BUGS

Please report any bugs or feature requests to bug-www-challonge at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WWW-Challonge::Participant. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc WWW::Challonge::Participant

You can also look for information at:

SEE ALSO

WWW::Challonge
WWW::Challonge::Tournament
WWW::Challonge::Match
WWW::Challonge::Match::Attachment

ACKNOWLEDGEMENTS

Everyone on the Challonge team for making such a great service.

LICENSE AND COPYRIGHT

Copyright 2015 Alex Kerr.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.