Package 

Class ParticipantLocalKt

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private final static <ERROR CLASS> ParticipantLocal

    • Method Summary

      Modifier and Type Method Description
      final <ERROR CLASS> getParticipantLocal() CompositionLocal for the Participant currently provided by ParticipantScopeNot to be confused with LocalParticipant.
      final static Unit ParticipantScope(Participant participant, Function0<Unit> content) Wraps content with a CompositionLocalProvider that binds participant to ParticipantLocal.
      final static Participant requireParticipant(Participant passedParticipant) Returns the passedParticipant or the currently provided ParticipantLocal.
      final static Unit ForEachParticipant(List<Participant> participants, Function1<Participant, Unit> content) A simple way to loop over participants that creates a ParticipantScope for each participant and calls content.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getParticipantLocal

         final <ERROR CLASS> getParticipantLocal()

        CompositionLocal for the Participant currently provided by ParticipantScope

        Not to be confused with LocalParticipant.

      • ParticipantScope

        @Composable() final static Unit ParticipantScope(Participant participant, Function0<Unit> content)

        Wraps content with a CompositionLocalProvider that binds participant to ParticipantLocal.

      • requireParticipant

        @Composable() final static Participant requireParticipant(Participant passedParticipant)

        Returns the passedParticipant or the currently provided ParticipantLocal.

      • ForEachParticipant

        @Composable() final static Unit ForEachParticipant(List<Participant> participants, Function1<Participant, Unit> content)

        A simple way to loop over participants that creates a ParticipantScope for each participant and calls content.