API.md

Friends

Friend (class) - Extends BaseModel

To gain access the methods of a friend you must first have an instance of a friend. You can obtain an instance by performing a query on the friend collection. A findOne will return an instance and a find will return a cursor which when iterated over will return an instance for each iteration.

Other methods for retaining information about friends or interacting with friends pertaining to the current user are also available on the User class and are detailed in the User Extensions section of this document.

var request = Meteor.friends.findOne(); //instance of Request

var requests = Meteor.friends.find();  //cursor which returns Request instances

All code examples in this section assume an instance of Friend as friend

user - The User instance for the friend.

friend.user(); //the user instance for the friend instance.

User Extensions

This package extends the socialize:user-model package with properties and methods that apply the the user in the context of friends and friend requests.

All code examples in this section assume an instance of User as currentUser

var currentUser = Meteor.user();

friendRequests(options) - Get the requests to the user. Returns a Mongo.Cursor which yields Request instances. Signature of options param is the same as you would pass to Collection.find().

{{#each currentUser.friendRequests}}
<div class="request">
    <p>{{requester.username}} would like to be friends</p>
    <p>
        <a href="#" data-action="accept">Accept</a>
        <a href="#" data-action="deny">Deny</a>
        <a href="#" data-action="ignore">Ignore</a>
    </p>
</div>
{{/each}}

numFriendRequests - The number of remaining requests to the user

<div class="badge success">{{currentUser.numFriendRequests}}</div>

pendingFriendRequests - A cursor of requests that the user has sent but have not been approved, denied or ignored.

{{#each currentUser.pendingFriendRequests}}
    <p>
        {{user.username}} - <a href="#" data-action="cancel">cancel request</a>
    </p>
{{/each}}

numPendingRequests - Get the number of requests that have not been responded to.

<p>
    You have {{currentUser.numPendingRequests}} requests to other users pending.
</p>

hasFriendshipRequestFrom(user) - Check if the user already has a request from someone.

<!-- assuming data context is user instance -->
{{#if currentUser.hasFriendshipRequestFrom this}}
    <div class="btn primary" data-action="accept">Accept Request</div>
{{/if}}

requestFriendship - Make a friend request from the current user.

Template.userProfile.events({
    'click [data-action=request]': function() {
        //assumes context is a instance of a user
        this.requestFriendship();
    }
});

cancelFriendshipRequest - Cancel request made from the currentUser to this user.

Template.userProfile.events({
    'click [data-action=cancel]': function() {
        //assumes context is a instance of a user
        this.cancelFriendshipRequest();
    }
});

acceptFriendshipRequest - Accept a friend request made from this user to the currentUser.

Template.userProfile.events({
    'click [data-action=accept]': function() {
        //assumes context is a instance of a user
        this.acceptFriendshipRequest();
    }
});

denyFriendshipRequest - Deny a friend request made from this user to the currentUser. Request won't be allowed to be re-made for User.restrictFriendshipRequestDays Days. Default is 30 days but you can modify this to suit your needs.

Template.userProfile.events({
    'click [data-action=deny]': function() {
        //assumes context is a instance of a user
        this.denyFriendshipRequest();
    }
});

ignoreFriendshipRequest - Ignores a friend request made from this user to the currentUser

Template.userProfile.events({
    'click [data-action=ignore]': function() {
        //assumes context is a instance of a user
        this.ignoreFriendshipRequest();
    }
});

friends(options) - Get friends for the user. Returns a Mongo.Cursor which yields Friend instances. Signature of options param is the same as you would pass to Collection.find().

{{#each currentUser.friends}}
    <!-- instance of Friend not User -->
    <p>{{user.username}}</p>
{{/each}}

friendsAsUsers(options) - Get friends for user as the users they represent. Returns a Mongo.Cursor which yields User instances. Signature of options param is the same as you would pass to Collection.find().

{{#each currentUser.friendsAsUsers}}
    <!-- User instances this time instead of Friend instances -->
    <p>{{username}}</p>
{{/each}}

unfriend - Sever the friendship connection between the user and the current user.

Template.userProfile.events({
    'click [data-action=unfriend]': function() {
        //assumes context is a instance of a user
        this.unfriend();
    }
});

isFriendsWith(userId) - Check if the current user has send a friendship request to the given user.

{{#if currentUser.isFriendsWith this._id}}
<p>You are friends with this user</p>
{{/if}}

Static Properties

User.restrictFriendshipRequestDays - The number of days to restrict a user from making another friend request to the same person.

User.restrictFriendshipRequestDays = 365; //don't allow new requests for a year.

Publications

socialize.friends(userId, options = { limit: 20, sort: { createdAt: -1 } }) - Publishes friend records with corresponding user records for the user specified by userId. This publication will not send any data if the specified user blocks the current user, or the current user blocks the specified user. Default limit is 20 and default sort is newest to oldest friends.

Meteor.subscribe('socialize.friends', Meteor.userId())

socialize.friendRequests(options = { limit: 10, sort: { createdAt: -1 } }) - Publishes friend request records for the current user from other users. Default limit is 10 and default sort is oldest to newest requests.

Meteor.subscribe('socialize.friendRequests', { limit: 5 })

socialize.pendingFriendRequests(options = { limit: 10, sort: { createdAt: -1 } }) - Publishes friend request records for the current user to other users. Default limit is 10 and default sort is oldest to newest requests.

Meteor.subscribe('socialize.pendingFriendRequests', { limit: 5 })

socialize.hasFriendRequest(requestedUser) - Publishes friend requests between the current user and requested user.

Meteor.subscribe('socialize.hasFriendRequest', profileUser._id);