P2PRoom

@objc
open class P2PRoom : Room

P2P通信を行うRoom

Room抽象クラスもご確認ください。

  • Declaration

    Swift

    public override var type: RoomType { get }
  • create(with:) Asynchronous

    Roomを作成します。

    optionsでRoomの名前を指定して作成できますが、同じ名前のRoomは作成することができません。

    Declaration

    Swift

    @available(iOS 13.0, *)
public override class func create(with options: InitOptions?) async throws -> P2PRoom

    Parameters

    options

    初期化オプション

    Return Value

    Room

  • Roomを作成します。

    optionsでRoomの名前を指定して作成できますが、同じ名前のRoomは作成することができません。

    Declaration

    Swift

    public override class func create(
    with options: InitOptions?,
    completion: ((P2PRoom?, Error?) -> Void)?
)

    Parameters

    options

    初期化オプション
    completion

    完了コールバック
  • find(by:) Asynchronous

    Roomクエリを元にRoomを検索します。

    クエリはRoomのIDまたはNameを入力します。両方とも入力される場合はIDが優先されます。

    Declaration

    Swift

    @available(iOS 13.0, *)
public override class func find(by query: Query) async throws -> P2PRoom

    Parameters

    query

    検索クエリ

    Return Value

    Room

  • Roomクエリを元にRoomを検索します。

    クエリはRoomのIDまたはNameを入力します。両方とも入力される場合はIDが優先されます。

    Declaration

    Swift

    public override class func find(
    by query: Query, completion: ((P2PRoom?, Error?) -> Void)?
)

    Parameters

    query

    検索クエリ
    completion

    完了コールバック
  • findOrCreate(with:) Asynchronous

    Roomを名前から検索し、存在しない場合は作成します。

    Declaration

    Swift

    @available(iOS 13.0, *)
public override class func findOrCreate(with options: InitOptions) async throws -> P2PRoom

    Parameters

    options

    検索・初期化オプション

    Return Value

    Room

  • Roomを名前から検索し、存在しない場合は作成します。

    Declaration

    Swift

    @objc
public class func findOrCreate(
    options: InitOptions,
    completion: ((P2PRoom?, Error?) -> Void)?
)

    Parameters

    options

    検索・初期化オプション
    completion

    完了コールバック
  • join(with:) Asynchronous

    RoomにLocalRoomMemberを作成し、入室させます。

    1RoomインスタンスにJoinできるLocalRoomMemberは1人だけです。

    Declaration

    Swift

    @available(iOS 13.0, *)
public override func join(with options: Room.MemberInitOptions?) async throws
    -> LocalP2PRoomMember

    Parameters

    options

    Member初期化オプション

    Return Value

    Member

  • RoomにLocalRoomMemberを作成し、入室させます。

    1RoomインスタンスにJoinできるLocalRoomMemberは1人だけです。

    Declaration

    Swift

    public override func join(
    with options: MemberInitOptions?,
    completion: ((LocalP2PRoomMember?, Error?) -> Void)?
)

    Parameters

    options

    Member初期化オプション
    completion

    完了コールバック