View Source Bonfire.Social.Bookmarks (Bonfire v0.9.11-social-beta.6)

Mutate or query bookmarks (similar to likes but only visible to the creator of the bookmark)

Bookmarks are implemented on top of the Bonfire.Data.Edges.Edge schema (see Bonfire.Social.Edges for shared functions)

Summary

Functions

bookmark(bookmarker, bookmarked, opts \\ [])

Bookmarks an object for a user.

bookmarked?(user, object)

Checks if a user has bookmarked an object.

by_bookmarked(object, opts \\ [])

Retrieves bookmark(er)s for an object.

by_bookmarker(subject, opts \\ [])

Retrieves bookmarked objects by a subject.

count(filters \\ [], opts \\ [])

Counts bookmarks based on filters and options.

get(subject, object, opts \\ [])

Retrieves a bookmark by subject and object.

get!(subject, object, opts \\ [])

Retrieves a bookmark edge, raising an error if not found.

list_by(by_user, opts \\ [])

Lists bookmarks by a specific user.

list_my(opts)

Lists the current user's bookmarks.

list_of(object, opts \\ [])

Lists bookmark(er)s of a specific object or objects.

query(filters, opts)

query_module()

Callback implementation for Bonfire.Common.ContextModule.query_module/0.

schema_module()

Callback implementation for Bonfire.Common.ContextModule.schema_module/0.

unbookmark(bookmarker, object, opts \\ [])

Removes a bookmark from an object for a user, if one exists

Functions

bookmark(bookmarker, bookmarked, opts \\ [])

Bookmarks an object for a user.

Examples

iex> Bonfire.Social.Bookmarks.bookmark(user, object)
{:ok, %Bonfire.Data.Social.Bookmark{}}

bookmarked?(user, object)

Checks if a user has bookmarked an object.

Examples

iex> Bonfire.Social.Bookmarks.bookmarked?(user, object)
true

by_bookmarked(object, opts \\ [])

Retrieves bookmark(er)s for an object.

Examples

iex> Bonfire.Social.Bookmarks.by_bookmarked(object)
[%Bonfire.Data.Social.Bookmark{}, ...]

by_bookmarker(subject, opts \\ [])

Retrieves bookmarked objects by a subject.

Examples

iex> Bonfire.Social.Bookmarks.by_bookmarker(user)
[%Bonfire.Data.Social.Bookmark{}, ...]

count(filters \\ [], opts \\ [])

Counts bookmarks based on filters and options.

Examples

iex> Bonfire.Social.Bookmarks.count([subject: user_id], [])
5

iex> Bonfire.Social.Bookmarks.count(user, object)
1

iex> Bonfire.Social.Bookmarks.count(object, [])
10

get(subject, object, opts \\ [])

Retrieves a bookmark by subject and object.

Examples

iex> Bonfire.Social.Bookmarks.get(user, object)
{:ok, %Bonfire.Data.Social.Bookmark{}}

get!(subject, object, opts \\ [])

Retrieves a bookmark edge, raising an error if not found.

list_by(by_user, opts \\ [])

Lists bookmarks by a specific user.

Examples

iex> Bonfire.Social.Bookmarks.list_by(user_id, current_user: me)
[%Bonfire.Data.Social.Bookmark{}, ...]

list_my(opts)

Lists the current user's bookmarks.

Examples

iex> Bonfire.Social.Bookmarks.list_my(current_user: me)
[%Bonfire.Data.Social.Bookmark{}, ...]

list_of(object, opts \\ [])

Lists bookmark(er)s of a specific object or objects.

Examples

iex> Bonfire.Social.Bookmarks.list_of(object_id)
[%Bonfire.Data.Social.Bookmark{}, ...]

query(filters, opts)

query_module()

Callback implementation for Bonfire.Common.ContextModule.query_module/0.

schema_module()

Callback implementation for Bonfire.Common.ContextModule.schema_module/0.

unbookmark(bookmarker, object, opts \\ [])

Removes a bookmark from an object for a user, if one exists

Examples

iex> Bonfire.Social.Bookmarks.unbookmark(user, object)
:ok